Migrate docs from mdbook to Docusaurus #701
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR migrates the existing documentation from mdbook to Docusaurus. This includes syntax changes and structural updates.
🚨 DO NOT MERGE YET 🚨
Merging this PR before all other Docusaurus PRs are ready will break the docs deployment! Also, merging has to be done in correct order to ensure a smooth transition!
Note
docs/src.docs/src/external, internal docs inside ofdocs/src/internal.Questions & Clarifications
I kept the md files inside of
docs/src/internalto keep supporting mdbook, so that the internal docs can be hosted as an mdbook on 0xmiden.github.io/miden-node/. These files are files that are currently not exported to the Miden book.That said, I believe it would be better to migrate these files to Docusaurus syntax as well. This would allow us to integrate the internal docs into the external documentation in the future, while also ensuring that developers only need to work with a single, consistent syntax (Docusaurus Markdown) instead of switching between mdBook and Docusaurus.
@bitwalker What do you think?
Changes
Syntax changes
As already mentioned before, this PR changes the markdown syntax of all docs markdown files.
Going forward all documentation will also be written using Docusaurus sytnax.
NOTE: Please review the updated Markdown files to understand the new format.
Local testing
To test docs locally before pushing changes:
cd docs/externalNote: The
index.mdfile might not appear in the correct sidebar order during local dev. In production deployments it will. To guarantee proper ordering, ensureindex.mdincludes:New Docs Architecture
The documentation system no longer relies on cron jobs or local scripts. Instead, changes are propagated through a CI-driven process. Here are the key changes:
Instead of relying on a cron task to update the docs, every repository now integrates a "trigger-docs-deploy.yml" workflow, which automatically triggers a rebuild and redeployment of the docs upon changes to
next.Upon Testnet deployments, a dedicated workflow inside of the miden-docs repository can be triggered to create a snapshot of the docs for that specific version. This workflow has to be triggered manually.