docs(redesign): restructure documentation to Library Skeleton pattern#518
Merged
docs(redesign): restructure documentation to Library Skeleton pattern#518
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #518 +/- ##
=======================================
Coverage 58.99% 58.99%
=======================================
Files 41 41
Lines 6457 6457
Branches 1082 1082
=======================================
Hits 3809 3809
Misses 2126 2126
Partials 522 522 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
tony
force-pushed
the
doc-redesign-spring-2026
branch
3 times, most recently
from
d72477c to
eee6ee8
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
why: The landing page dumped the README. No unified API landing page
for the 3 subsections (url, cmd, sync). Homepage cards were generic
("Topics", "API Reference") instead of reflecting the product's
three-layer architecture. No contributor section.
what:
Landing page:
- Compose standalone homepage with specific hero about URL parsing,
commands, and sync
- Two responsive 3-card grid rows matching the architecture:
Quickstart/URL Parsing/Commands + Sync/pytest Plugin/Project
- Install snippet with pre-1.0 pin tip (in {tip} admonition)
- "At a glance" GitURL parsing example + 3-layer table
- Testing section showing pytest plugin fixtures
Structure:
- Create api/index.md as narrative hub linking url/, cmd/, sync/
- Move pytest-plugin.md → api/pytest-plugin.md
- Rename contributing/ → project/ with grid cards:
contributing.md, workflow.md (preserved), code-style.md, releasing.md
- Add responsive grid cards to all section index pages:
url/index.md, cmd/index.md, sync/index.md, topics/index.md,
internals/index.md, project/index.md
Dependencies:
- Add sphinx-design to docs and dev dependency groups
- Add sphinx_design extension and myst_heading_anchors = 4 to conf.py
Redirects:
- contributing/index.md → project/contributing.md
- contributing/workflow.md → project/workflow.md
- pytest-plugin.md → api/pytest-plugin.md
- Updated stale developing.md redirect to project/contributing.md
tony
force-pushed
the
doc-redesign-spring-2026
branch
from
eee6ee8 to
c59ecee
Compare
tony
force-pushed
the
doc-redesign-spring-2026
branch
from
b0c7b89 to
c59ecee
Compare
tony
added a commit
that referenced
this pull request
Mar 24, 2026
docs(redesign) — Library Skeleton pattern (#518) Restructure libvcs documentation to the Library Skeleton. api/index.md created as narrative hub for url/, cmd/, sync/ subsections. Architecture- aligned homepage cards (URL Parsing, Commands, Sync, pytest Plugin). contributing/ renamed to project/. Grid cards on all section indexes. sphinx-design added.
tony
added a commit
that referenced
this pull request
Mar 25, 2026
Restructure libvcs documentation to the Library Skeleton. api/index.md created as narrative hub for url/, cmd/, sync/ subsections. Architecture- aligned homepage cards (URL Parsing, Commands, Sync, pytest Plugin). contributing/ renamed to project/. Grid cards on all section indexes. 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.