docs: add Reference section (#28)#37
Merged
shouze merged 2 commits intofeat/vitepress-docsfrom Feb 23, 2026
Merged
Conversation
- cli-options.md: full table of all search options (--org, --exclude-repositories, --exclude-extracts, --no-interactive, --format, --output-type, --include-archived, --group-by-team-prefix, --no-cache) + global options (-V, -h) + usage notes - keyboard-shortcuts.md: navigation, selection, filter mode (f / r / Esc / Enter), help and exit (h/? / Enter / q / Ctrl+C), with section for filter-mode bindings - github-api-limits.md: result limits (1,000 max, page 10 hard cap, 256 char query), rate limits (10 unauth / 30 auth req/min), query syntax constraints (no regex, max 5 booleans, NOT behaviour, qualifier-only rejection), pagination behaviour, 3 official GitHub documentation links - environment.md: GITHUB_TOKEN (required scopes), CI, GITHUB_CODE_SEARCH_CACHE_DIR (override + default OS paths table)
There was a problem hiding this comment.
Pull request overview
Adds a new Reference section to the VitePress documentation, covering CLI options, keyboard shortcuts, GitHub API limits, and environment variables for github-code-search.
Changes:
- Added
docs/reference/cli-options.mdwith command usage and option tables. - Added
docs/reference/keyboard-shortcuts.mddocumenting TUI key bindings (navigation/selection/filter/help/exit). - Added
docs/reference/github-api-limits.mdanddocs/reference/environment.mdto document GitHub constraints and runtime env vars.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 9 comments.
| File | Description |
|---|---|
| docs/reference/cli-options.md | Documents CLI commands and options in a tabular reference format. |
| docs/reference/keyboard-shortcuts.md | Documents interactive TUI keyboard bindings and filter-mode bindings. |
| docs/reference/github-api-limits.md | Summarizes GitHub code search limits, rate limits, and links official docs. |
| docs/reference/environment.md | Documents GITHUB_TOKEN, CI, and cache directory override behavior. |
- cli-options.md: add intro paragraph; fix <query> required arg; fix --no-interactive and --no-cache defaults to 'true (on)' with clarified descriptions - keyboard-shortcuts.md: keys are case-sensitive, lowercase only; add j/k vim navigation aliases; fix filter mode table: Printable characters + Backspace; clarify Enter when help overlay open vs closed - github-api-limits.md: remove 'deduplicated' from pagination section; fix rate limit callout to say 'retry after reset time'
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Implements #28 — the complete Reference section of the documentation site.
What changed
4 new pages under
docs/reference/:cli-options.mdgithub-code-search.ts:--org,--exclude-repositories,--exclude-extracts,--no-interactive,--format,--output-type,--include-archived,--group-by-team-prefix,--no-cache— plus global options-V/-hand usage noteskeyboard-shortcuts.md↑↓←→), selection (Space/a/n), filter mode (f/r) with dedicated filter-mode binding table (Enterconfirm /Esccancel), help and exit (h/?/Enter/q/Ctrl+C)github-api-limits.mdNOTbehaviour, qualifier-only rejection), pagination behaviour, 3 official GitHub documentation linksenvironment.mdGITHUB_TOKEN(required scopes table),CI(disables TUI),GITHUB_CODE_SEARCH_CACHE_DIR(override + default paths per OS)Acceptance criteria
github-api-limits.mdincludes 3 links to official GitHub documentationgithub-code-search.tsexactly (including--no-cache)How to test
bun run docs:dev # → navigate to http://localhost:5173/github-code-search/reference/cli-options