feat: show version in docs navbar

[23prime]

Checklist

• Target branch is main
• Status checks are passing

Summary

• Pass DOCS_VERSION env var (= git tag name) to the Docusaurus build step in docs.yml
• Read process.env.DOCS_VERSION in docusaurus.config.js and display it as an HTML navbar item (falls back to dev when not set)

Reason for change

Users visiting the docs site had no way to know which version the docs correspond to.

Changes

• .github/workflows/docs.yml: add env.DOCS_VERSION: ${{ github.ref_name }} to the build step
• website/docusaurus.config.js: add version constant and a type: 'html' navbar item showing it

Notes

• workflow_dispatch runs (manual trigger without a tag) will show dev as the version label.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c5611aae-d5fa-4469-902f-aa40ebfe524f

📥 Commits

Reviewing files that changed from the base of the PR and between 47c977f and 4fff8d7.

📒 Files selected for processing (2)

• .github/workflows/docs.yml
• website/docusaurus.config.js

---

📝 Walkthrough

Walkthrough

The pull request adds documentation versioning support by introducing a DOCS_VERSION environment variable in the CI workflow that captures git tag information, and configures Docusaurus to display this version in the navbar with HTML-escaped rendering.

Changes

Cohort / File(s)	Summary
Workflow Configuration .github/workflows/docs.yml	Added DOCS_VERSION environment variable to the Build step, conditionally set to git tag name when building from tag push events, otherwise empty string.
Docusaurus Configuration website/docusaurus.config.js	Introduced version constant sourced from DOCS_VERSION env var (defaults to 'dev'), added escapeHtml() utility function for sanitization, and injected a navbar item to display the escaped version string on the right side.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A version hops into the navbar bright,
Tagged with care, and escaped just right,
From workflows deep to docs so fine,
The version string now has a place to shine!

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'feat: show version in docs navbar' clearly and concisely summarizes the main feature being added—displaying the version in the documentation navbar.
Description check	✅ Passed	The description is directly related to the changeset, providing clear context about passing DOCS_VERSION to the build step and displaying it in the navbar with appropriate fallback behavior.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

• 📝 Generate docstrings (stacked PR)
• 📝 Generate docstrings (commit on current branch)

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch feature/docs-version-in-navbar

✨ Simplify code

• Create PR with simplified code
• Commit simplified code in branch feature/docs-version-in-navbar

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull request overview

Adds a build-time docs version label so users can see which tagged release the published Docusaurus site corresponds to.

Changes:

• Passes DOCS_VERSION (from github.ref_name) into the docs build step in the GitHub Pages workflow.
• Reads process.env.DOCS_VERSION in Docusaurus config and displays it in the navbar (fallback dev).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
.github/workflows/docs.yml	Exposes the git ref/tag name to the docs build via DOCS_VERSION.
website/docusaurus.config.js	Adds a navbar item that renders the version string from DOCS_VERSION (or dev).