Skip to content

docs: add getting-started, cli, configuration, and architecture sections#23

Merged
himewel merged 2 commits into
mainfrom
docs/expand-sections
May 17, 2026
Merged

docs: add getting-started, cli, configuration, and architecture sections#23
himewel merged 2 commits into
mainfrom
docs/expand-sections

Conversation

@himewel

@himewel himewel commented May 17, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds four new doc pages mirroring the q2google structure: Getting Started, CLI, Configuration, and Architecture
  • Adds a quick-links card grid to docs/index.md so every section is reachable from the home page
  • Upgrades mkdocs.yml with Mermaid support (pymdownx.superfences), admonitions, tabbed content, emoji, and richer mkdocstrings options
  • Adds a CI auto-label job that tags PRs with conventional-commit-based labels

New pages

Page Contents
getting-started.md Install (PyPI / source / wheel), token setup, sync & async quick-start
cli.md Full reference for search, info, pull — all flags and examples
configuration.md GP_ACCESS_TOKEN env var, .env usage, tabbed browser retrieval guide
ARCHITECTURE.md Flowchart, sequence diagram, and class diagram (all Mermaid)

Test plan

  • mkdocs serve renders all new pages without errors
  • Mermaid diagrams display correctly in the Architecture page
  • Card grid renders on the Home page
  • Tabbed browser instructions render on the Configuration page
  • Admonition warnings render on the Configuration page

Made with Cursor

himewel and others added 2 commits May 17, 2026 20:50
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>
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 17, 2026
@himewel himewel merged commit e0f365e into main May 17, 2026
5 checks passed
@himewel himewel deleted the docs/expand-sections branch May 17, 2026 23:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant