Skip to content

[Docs] Enabling Docusaurus versions#1312

Open
indeewari wants to merge 3 commits intoasgardeo:mainfrom
indeewari:docusaraus_versions
Open

[Docs] Enabling Docusaurus versions#1312
indeewari wants to merge 3 commits intoasgardeo:mainfrom
indeewari:docusaraus_versions

Conversation

@indeewari
Copy link

@indeewari indeewari commented Feb 6, 2026

Parent issue

This pull request updates the Docusaurus documentation site configuration to enable versioning and prepare for public access. The main changes focus on introducing documentation version management and updating navigation elements.

Documentation versioning:

  • Enabled documentation versioning by setting lastVersion to 'current' and defining a versions object with a labeled 'Next' version in docs/docusaurus.config.ts.
  • Added a version dropdown to the navbar for easy navigation between documentation versions in docs/docusaurus.config.ts.

Site indexing:

  • Commented out the noIndex flag, which previously prevented search engines from indexing the site, signaling readiness for public access in docs/docusaurus.config.ts.

Summary by CodeRabbit

  • Documentation
    • Added a documentation version switcher in the navbar so users can select the "Next" docs version.
    • Introduced a "Next" docs version for previewing upcoming content.
    • Documentation remains excluded from search engine indexing (noIndex is still enabled).

Copilot AI review requested due to automatic review settings February 6, 2026 04:59
@coderabbitai
Copy link

coderabbitai bot commented Feb 6, 2026

📝 Walkthrough

Walkthrough

Updates the Docusaurus config to add docs versioning (sets lastVersion: 'current' and a versions entry with label Next and path next) and inserts a docsVersionDropdown navbar item. The existing noIndex: true flag was left unchanged.

Changes

Cohort / File(s) Summary
Docusaurus Configuration
docs/docusaurus.config.ts
Added docs versioning: lastVersion: 'current' and versions entry (current.label = 'Next', current.path = 'next'); added a type: 'docsVersionDropdown' navbar item positioned right. noIndex: true remains unchanged.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

Poem

🐰
I hopped through configs, neat and quick,
Added versions, labeled "Next" so slick,
A dropdown springs where users click,
Docs lined up, no change to indexing—
Carrots for versioned reading, pick! 🥕

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Description check ⚠️ Warning The description covers Purpose and provides context via parent issue, but lacks Approach section, manual test verification, and documentation/test checklist items required by the template. Add Approach section explaining implementation details and design decisions, confirm manual testing was performed, include documentation links, and complete the checklist items from the template.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: enabling Docusaurus versioning in the documentation configuration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request partially implements documentation versioning for the Thunder project by configuring Docusaurus to support version management. The changes prepare the infrastructure for multi-version documentation but do not complete the full implementation described in the parent issue #1210.

Changes:

  • Configured Docusaurus versioning with 'current' as the last version labeled as 'Next' accessible via /next path
  • Added a version dropdown to the navbar for version navigation
  • Commented out the noIndex flag to allow search engine indexing

Comment on lines +72 to +79
// Versioning.
lastVersion: 'current',
versions: {
current: {
label: 'Next',
path: 'next',
},
},
Copy link

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Per the parent issue #1210, the CI/CD configuration should be updated to:

  1. Release a new documentation version when doing a Thunder release
  2. Update the 'next' version when merging to main

However, this PR only updates the Docusaurus configuration without implementing the corresponding CI/CD automation. The existing .github/workflows/release-builder.yml and .github/workflows/nightly-build-validation.yml workflows deploy documentation but don't create versioned documentation snapshots.

Consider either:

  1. Implementing the CI/CD changes in this PR to fully address issue [Docs] Versioning support for Thunder Documentation #1210, or
  2. Creating a follow-up issue/PR for the CI/CD automation and documenting this limitation in the PR description

Copilot uses AI. Check for mistakes.
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot open a new pull request to apply changes based on this feedback

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot Create a follow-up issue/PR for the CI/CD automation and documenting this limitation in the PR description

Comment on lines +72 to +79
// Versioning.
lastVersion: 'current',
versions: {
current: {
label: 'Next',
path: 'next',
},
},
Copy link

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The versioning configuration is incomplete. According to Docusaurus best practices and the project's own documentation (docs/content/community/contributing/contributing-code/documentation-development/advanced-topics.mdx:405-413), enabling versioning requires creating actual versioned documentation files and a versions.json file using the pnpm docusaurus docs:version command.

Currently, only the configuration is added but no actual versioned documentation exists. This means:

  1. The version dropdown will appear but have no other versions to select
  2. No versions.json file exists to track versions
  3. No versioned_docs/ or versioned_sidebars/ directories exist

While it's acceptable to prepare the configuration in advance, consider adding a comment or documentation update explaining that actual versions will be created during release processes, or ensure the CI/CD workflow mentioned in issue #1210 is implemented to automatically create versions.

Suggested change
// Versioning.
lastVersion: 'current',
versions: {
current: {
label: 'Next',
path: 'next',
},
},
// Note: Docusaurus docs versioning is intentionally not enabled yet.
// Actual versions and the versions.json file will be created during the
// release process using `pnpm docusaurus docs:version` once the
// versioning workflow is in place. Until then, the docs run in
// single-version mode to avoid an incomplete version dropdown.

Copilot uses AI. Check for mistakes.
@codecov
Copy link

codecov bot commented Feb 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.92%. Comparing base (e7c49b6) to head (7b0f084).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1312   +/-   ##
=======================================
  Coverage   89.92%   89.92%           
=======================================
  Files         625      625           
  Lines       40662    40662           
  Branches     2371     2371           
=======================================
  Hits        36566    36566           
  Misses       2217     2217           
  Partials     1879     1879           
Flag Coverage Δ
backend-integration-postgres 52.94% <ø> (ø)
backend-integration-sqlite 52.91% <ø> (ø)
backend-unit 82.65% <ø> (ø)
frontend-apps-develop-unit 90.76% <ø> (ø)
frontend-apps-gate-unit 84.62% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copilot AI review requested due to automatic review settings February 6, 2026 06:00
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@brionmario brionmario added the skip-changelog Skip generating changelog for a particular PR label Feb 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip-changelog Skip generating changelog for a particular PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants