Skip to content

Versioning the user guide

MkDocs makes it easy to keep one guide for the latest version and separate pages for older releases.

docs/
  index.md
  versioning.md
  releases/
    1.0.md
    1.1.md
    2.0.md

How to use it

  • Keep index.md as the current guide for the latest release.
  • Copy that page into a release page when a version needs its own instructions.
  • Keep older pages short and version-specific so users can see what changed.
  • Link release notes or app store version numbers near the top of each page.

If you want a cleaner version selector later

If the guide grows, you can add a version picker with a docs workflow such as mike, or keep the release pages in separate folders and link them from a version landing page.

For Firebase Hosting, the simplest option is still one MkDocs build per version, each published into its own folder.