Skip to content

docs: Fix command for versioning documentation #952

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
msluszniak merged 1 commit into from
Mar 10, 2026
Merged

docs: Fix command for versioning documentation #952

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ We use Docusaurus versioning to "freeze" documentation for older releases.
When you release a new npm version (e.g., `1.0.0`), you must snapshot the documentation. Run this command from the `docs/` folder:

```bash
yarn docusaurus docs:version 1.0.0
yarn docs:version 1.0.0
```
### Why is this important?

Expand All @@ -109,4 +109,4 @@ This deletes the `.docusaurus` cache and `build` folder.
TypeDoc runs strictly at startup. If you modify comments in the TypeScript package:

1. Stop the server.
2. Run `yarn start` again to regenerate the Markdown files.
2. Run `yarn start` again to regenerate the Markdown files.