docs(redesign): restructure documentation to Library Skeleton pattern#536
Merged
docs(redesign): restructure documentation to Library Skeleton pattern#536
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #536 +/- ##
=======================================
Coverage 84.24% 84.24%
=======================================
Files 29 29
Lines 3795 3795
Branches 756 756
=======================================
Hits 3197 3197
Misses 378 378
Partials 220 220 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
tony
force-pushed
the
doc-redesign-spring-2026
branch
from
e68771e to
e2487e7
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 a demo GIF. Python API surface (api/cli/, api/internals/) was mixed with public CLI reference at the same sidebar level. No grid cards, no contributor section. what: Landing page: - Compose standalone homepage with one-sentence hero - Two responsive grid rows: Quickstart/CLI/Configuration + Internals/Contributing - Install snippet (pip + uv tool + pipx) - "At a glance" YAML config + vcspull sync + demo GIF Structure: - Move api/internals/ → internals/api/ (internal Python modules) - Move api/cli/ → internals/api/cli/ (Python CLI surface is internal) - Create internals/index.md with instability warning + grid cards - Move developing.md → project/contributing.md - Create project/ section with grid cards: contributing.md, code-style.md, releasing.md - Add responsive grid cards to cli/index.md (10 commands), configuration/index.md, api/index.md (trimmed to public modules) Dependencies: - Add sphinx-design to docs and dev dependency groups - Add sphinx_design extension and myst_heading_anchors = 4 to conf.py Redirects: - 14 redirect entries for all moved files under api/internals/, api/cli/, and developing.md
tony
force-pushed
the
doc-redesign-spring-2026
branch
from
e2487e7 to
6163872
Compare
tony
force-pushed
the
doc-redesign-spring-2026
branch
from
8159827 to
6163872
Compare
tony
added a commit
that referenced
this pull request
Mar 24, 2026
docs(redesign) — CLI Frontend Skeleton pattern (#536) Restructure vcspull documentation to the CLI Frontend Skeleton. Python API surface moved to internals/ (api/cli/, api/internals/). CLI index with 10 command cards. Configuration cards. Standalone composed homepage with YAML config example. project/ section. 14 redirects. sphinx-design added.
tony
added a commit
that referenced
this pull request
Mar 25, 2026
Restructure vcspull documentation to the CLI Frontend Skeleton. Python API surface moved to internals/ (api/cli/, api/internals/). CLI index with 10 command cards. Configuration cards. Standalone composed homepage with YAML config example. project/ section. 14 redirects. 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
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.
Composed landing page, responsive grid cards, topics/, project/, internals/ sections. See commit for details.