Skip to content

Adds versioning to documentation. Closes #1999#7188

Merged
Adam-it merged 1 commit intopnp:mainfrom
milanholemans:docs-versioning
Apr 4, 2026
Merged

Adds versioning to documentation. Closes #1999#7188
Adam-it merged 1 commit intopnp:mainfrom
milanholemans:docs-versioning

Conversation

@milanholemans
Copy link
Copy Markdown
Contributor

Closes #1999


Introduces docs versioning. There will be two versions: v11.6.0 (current stable) and beta. Docs will automatically treat the latest stable as the default version.

A demo of the docs can be found at: https://milanholemans.github.io/cli-microsoft365

To create a local build, just run node scripts/create-docs-versioning.mjs before running npm run start.
npm run clear will clear the created versions as well.

Copilot AI review requested due to automatic review settings April 4, 2026 15:22
Copy link
Copy Markdown

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

Introduces Docusaurus documentation versioning so the published docs can be viewed for the latest stable CLI release and for the beta (“current”) docs.

Changes:

  • Add a script to generate a stable docs snapshot from the latest git tag and configure CI to run it before building docs.
  • Update Docusaurus configuration to set stable as the default version and expose a version dropdown (stable vs beta).
  • Ignore generated versioning artifacts and extend docs cleanup to remove versioned outputs.

Reviewed changes

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

Show a summary per file
File Description
scripts/create-docs-versioning.mjs Generates the stable docs version from the latest git tag and restores the working tree afterwards.
docs/package.json Extends clear to remove Docusaurus versioning artifacts.
docs/docusaurus.config.ts Adds stable/beta version config and a docs version dropdown; updates edit URL.
.gitignore Ignores generated versioned_docs, versioned_sidebars, and versions.json.
.github/workflows/release_next.yml Runs docs versioning preparation before building docs.
.github/workflows/deploy_docs.yml Runs docs versioning preparation before building docs.
.github/workflows/check_pr.yml Runs docs versioning preparation before building docs in PR checks.

@Adam-it Adam-it self-assigned this Apr 4, 2026
@Adam-it Adam-it changed the title Adds versioning to documentation Adds versioning to documentation. Closes #1999 Apr 4, 2026
Copy link
Copy Markdown
Member

@Adam-it Adam-it left a comment

Choose a reason for hiding this comment

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

Checked locally ✅
Awesome work
only tircky part is that 11.6 so last stabe version in the about/release-notes show 11.6 as beta 🙂

Image

I get it, because it is build on the last commit from the 11.6 tag, but still looks strange. 🤔. Maybe in the future we could make the release-notes update as a separate commit and add the release tag to that commit. Other than that I don't have anything to add

@Adam-it Adam-it merged commit 7182dbb into pnp:main Apr 4, 2026
10 checks passed
@milanholemans
Copy link
Copy Markdown
Contributor Author

milanholemans commented Apr 4, 2026

Yes, noticed the release notes as well. We should definitely pay attention to create a separate commit. But I think we can live with it for 1 month.

@milanholemans milanholemans deleted the docs-versioning branch April 4, 2026 21:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs improvement: Docs version matching CLI version.

3 participants