Skip to content

docs: set up MkDocs versioned docs with mike #297

@Aureliolo

Description

@Aureliolo

Summary

Enable versioned documentation using mike so users can access docs for specific SynthOrg versions.

Tasks

  • Add mike to docs dependency group
  • Configure mike in mkdocs.yml (version selector, alias latest)
  • Update GitHub Pages workflow to use mike deploy instead of mkdocs 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    prio:lowNice to have, can deferscope:smallLess than 1 day of worktype:docsDocumentation workv0.4Minor version v0.4v0.4.9Patch release v0.4.9

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions