-
Notifications
You must be signed in to change notification settings - Fork 58
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request
Description
Description
Currently, the documentation deployment script (update-gh-pages-documentation.sh) publishes documentation without version tracking. After each release, we should be able to generate and maintain documentation for specific versions.
Proposed Solution
Add a --version parameter to the documentation update script that:
- Accepts a version identifier (e.g.,
0.1.0,1.0.0) - Organizes documentation output by version in the gh-pages branch
- Maintains a version selector or index page to navigate between different versions
Suggested Implementation
Script Changes
- Add
--version VERSIONparameter toScripts/update-gh-pages-documentation.sh - Modify the deployment path to include version:
gh-pages/docs/{version}/ - Generate or update an index page listing all available versions
- Optionally create a
latestsymlink or redirect to the most recent version
Workflow
After each tag release, GitHub workflow should automatically run the following command
./Scripts/update-gh-pages-documentation.sh --version 0.1.0Directory Structure
gh-pages/
├── docs/
│ ├── v0.1.0/
│ ├── v0.2.0/
│ ├── latest/ (symlink or copy)
│ └── index.html (version selector)
└── .nojekyll
Benefits
- Users can reference documentation for specific versions they're using
- Maintains historical documentation for older releases
- Improves documentation discoverability and usability
- Aligns with common documentation practices (e.g., Swift.org, Vapor, etc.)
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or request