docs: add getting-started, cli, configuration, and architecture sections#23
Merged
Conversation
Co-authored-by: Cursor <cursoragent@cursor.com>
- getting-started.md: installation, token setup, sync/async quick-start - cli.md: full reference for search, info, and pull with all flags - configuration.md: GP_ACCESS_TOKEN setup with tabbed browser instructions - ARCHITECTURE.md: layer overview, data-flow sequence, and exception hierarchy using Mermaid diagrams - docs/index.md: quick-links card grid pointing to every section - mkdocs.yml: wire new pages into nav; enable admonition, tabbed, superfences (Mermaid), emoji, toc, and richer mkdocstrings options Co-authored-by: Cursor <cursoragent@cursor.com>
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
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.
Summary
docs/index.mdso every section is reachable from the home pagemkdocs.ymlwith Mermaid support (pymdownx.superfences), admonitions, tabbed content, emoji, and richermkdocstringsoptionsNew pages
getting-started.mdcli.mdsearch,info,pull— all flags and examplesconfiguration.mdGP_ACCESS_TOKENenv var,.envusage, tabbed browser retrieval guideARCHITECTURE.mdTest plan
mkdocs serverenders all new pages without errorsMade with Cursor