-
Notifications
You must be signed in to change notification settings - Fork 0
docs: set up MkDocs versioned docs with mike #297
Copy link
Copy link
Closed
Labels
prio:lowNice to have, can deferNice to have, can deferscope:smallLess than 1 day of workLess than 1 day of worktype:docsDocumentation workDocumentation workv0.4Minor version v0.4Minor version v0.4v0.4.9Patch release v0.4.9Patch release v0.4.9
Description
Summary
Enable versioned documentation using mike so users can access docs for specific SynthOrg versions.
Tasks
- Add
miketo docs dependency group - Configure mike in
mkdocs.yml(version selector, aliaslatest) - Update GitHub Pages workflow to use
mike deployinstead ofmkdocs build - Set up version aliases (e.g.,
latest,0.1,0.2)
Notes
- Not needed until there are multiple released versions
- mike is the standard versioning tool for MkDocs Material
- See ADR-003 for documentation architecture decisions
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
prio:lowNice to have, can deferNice to have, can deferscope:smallLess than 1 day of workLess than 1 day of worktype:docsDocumentation workDocumentation workv0.4Minor version v0.4Minor version v0.4v0.4.9Patch release v0.4.9Patch release v0.4.9