docs(redesign): restructure documentation to CLI Frontend Skeleton pattern#51
Merged
docs(redesign): restructure documentation to CLI Frontend Skeleton pattern#51
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #51 +/- ##
=======================================
Coverage 85.52% 85.53%
=======================================
Files 27 27
Lines 2529 2530 +1
=======================================
+ Hits 2163 2164 +1
Misses 366 366 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
tony
force-pushed
the
doc-redesign-spring-2026
branch
from
f3b623e to
f46bf7a
Compare
…e URLs why: sphinx-design is needed for grid cards in the documentation landing pages and section indexes. Doc-site URLs added as inline comments for quick reference when managing dependencies. what: - Add sphinx-design to docs and dev dependency groups - Annotate all doc dependencies with their documentation URLs
…ttern
why: The landing page dumped the README with no visual navigation.
No grid cards, no responsive layout, no contributor section. The
sidebar was a flat toctree with no hierarchy.
what:
Landing page:
- Compose standalone homepage with one-sentence hero, responsive
1x3 grid cards (Quickstart, CLI Reference, Contributing), install
snippet (pip + uv), and "At a glance" example showing `g status`
- Remove README {include} entirely
Structure:
- Create project/ section with grid cards:
contributing.md (moved from developing.md), code-style.md, releasing.md
- Add grid cards to cli/index.md for command navigation
Dependencies:
- Add sphinx-design to docs and dev dependency groups
- Add sphinx_design extension and myst_heading_anchors = 4 to conf.py
Redirects:
- developing.md → project/contributing.md
tony
force-pushed
the
doc-redesign-spring-2026
branch
from
f46bf7a to
10b2005
Compare
tony
force-pushed
the
doc-redesign-spring-2026
branch
from
2d489d9 to
10b2005
Compare
tony
added a commit
that referenced
this pull request
Mar 24, 2026
docs(redesign) — CLI Frontend Skeleton pattern (#51) Restructure g documentation to the CLI Frontend Documentation Skeleton. Standalone composed homepage with grid cards. project/ section with contributing, code-style, releasing. sphinx-design added.
tony
added a commit
that referenced
this pull request
Mar 25, 2026
Restructure g documentation to the CLI Frontend Documentation Skeleton. Standalone composed homepage with grid cards. project/ section with contributing, code-style, releasing. sphinx-design added.
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
2 participants
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.
Composed landing page, responsive grid cards, project/ section. See commit message for details.