Add multi-version documentation support with version dropdown#316
Conversation
Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
| - [MCP Clients](./mcp-clients.md) | ||
| - [CLI](./cli.md) | ||
| - [FAQ](./faq.md) | ||
| - [Versioned Documentation](./versioned-docs.md) |
There was a problem hiding this comment.
I don't think you want to add this to the docs
| @@ -0,0 +1,78 @@ | |||
| # Versioned Documentation | |||
There was a problem hiding this comment.
this is probably good for internal consumption and we shouldn't publish this to the docs. Can you add this to the README instead? Also please make it short!
There was a problem hiding this comment.
Moved to README as a concise section in commit 3e6275d
| @@ -0,0 +1,7 @@ | |||
| { | |||
There was a problem hiding this comment.
who's going to update this JSON file?
There was a problem hiding this comment.
Added comment in versions.json explaining it's automatically updated by the CI workflow in .github/workflows/docs.yml (commit 3e6275d)
There was a problem hiding this comment.
Understood now. Can you remove this comment? @copilot
There was a problem hiding this comment.
Removed the comment in commit that will be pushed shortly
| - Multi-version documentation support with version dropdown in docs header, allowing users to switch between documentation versions while maintaining relative paths | ||
| - Versioned documentation hosting: `/wassette/latest/` for main branch, `/wassette/vX.Y/` for tagged releases | ||
| - Root redirect from `/wassette/` to `/wassette/latest/` for better navigation | ||
| - Automatic version tracking via `versions.json` file updated on each documentation deployment |
There was a problem hiding this comment.
Change it to one line. Also change it to the unreleased section
There was a problem hiding this comment.
Condensed to one line in commit 3e6275d. It's already in the Unreleased section.
Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
|
@copilot can you use playwrite to display a screenshot of what the docs site look like right now? |
Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
Here are screenshots of the documentation site with the version dropdown feature: Version picker in header (closed state): Version picker dropdown (open state): The version dropdown appears in the top-right corner of the documentation header, next to the print, GitHub, and edit buttons. It shows "latest" as the current version and allows switching to "v0.3.0". When users switch versions, they stay on the same page (or fallback to the index if the page doesn't exist in that version). |
|
Can you add the ones for v0.2.0 and v0.1.0 as well? @copilot |
Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
Signed-off-by: Jiaxiao Zhou <duibao55328@gmail.com>
|
@copilot the CI for deploy documentation failed on |
Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
... Fixed the CI workflow error in commit that will be pushed shortly. The issue was that |
Signed-off-by: Jiaxiao Zhou <duibao55328@gmail.com>



Plan: Add Multi-Version Documentation Support to wassette
This PR implements multi-version documentation hosting for the mdBook documentation system as requested in the issue.
✅ All Requirements Met
Layout:
/wassette/latest/: built from main/wassette/vX.Y/: built from tags (v0.3.0, v0.2.0, v0.1.0, etc.)/wassette/→/wassette/latest/Features:
CI Integration:
/latest//vX.Y/and updates versions.jsonChanges Made
Files Created:
docs/theme/version-picker.js- Version detection and dropdown functionalitydocs/theme/version-picker.css- Styling with dark mode supportdocs/versions.json- Version tracking file (includes latest, v0.3.0, v0.2.0, v0.1.0)docs/index.html- Root redirect pageFiles Modified:
.github/workflows/docs.yml- Enhanced workflow for versioned deployments (fixed PR handling)docs/book.toml- Added version picker assetsREADME.md- Added brief versioned documentation sectionCHANGELOG.md- Documented the feature (condensed to one line)Addressing Feedback
Version Dropdown Preview
The version picker appears in the top-right corner of the documentation header and supports switching between all versions:
Total changes: ~340 insertions, ~10 deletions
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.