Skip to content

feat: Adds versioned documentation#1664

Open
jknndy wants to merge 2 commits intohhursev:mainfrom
jknndy:versioned-docs
Open

feat: Adds versioned documentation#1664
jknndy wants to merge 2 commits intohhursev:mainfrom
jknndy:versioned-docs

Conversation

@jknndy
Copy link
Copy Markdown
Collaborator

@jknndy jknndy commented Aug 15, 2025

Resolves #1663

Not related changes

  • Cache pip on run

publish.yaml

  • Adds permissions for write to allow doc updates
  • Install doc dependencies
  • Add mike to automatically deploy versioned docs
  • Release flow update to allow versioned docs

Docs

  • Added a “Publishing Versioned Docs” section to the contributor guide, explaining that releases automatically publish docs with Mike and how to run the same commands locally when needed
  • Highlighted in the supported-sites page that older site lists remain accessible via versioned URLs (e.g., /15.8.0/getting-started/supported-sites/) for compatibility checks

@tomtjes , not sure if you're familiar with mike but if you want to take a look any feedback would be appreciated!

@jknndy jknndy requested a review from hhursev August 15, 2025 21:23
@jknndy jknndy marked this pull request as ready for review August 15, 2025 21:23
@tomtjes
Copy link
Copy Markdown
Contributor

tomtjes commented Aug 15, 2025

Awesome! Don't know anything about mike though, sorry

@hhursev
Copy link
Copy Markdown
Owner

hhursev commented Sep 20, 2025

Very important PR! This looks very elegant. I'll take a look right now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Versioning for list of supported sites

3 participants