-
Notifications
You must be signed in to change notification settings - Fork 531
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.
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
feat(docs): Replace Hugo with Docusaurus #22990
base: main
Are you sure you want to change the base?
Conversation
**NOTE: THIS PR TARGETS A DEV BRANCH, NOT MAIN.** Updates the website to use Docusaurus.
These are mostly stemming from an |
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output
|
Docusaurus
Updates the website (/docs) to leverage Docusaurus in place of Hugo as its static site generator.
Functional changes
Versioning
The existing Hugo-based site only has a partial versioning story.
The API docs are versioned, but the rest of the content isn't.
This creates a messy story where our hand-written docs likely only discuss topics related to the current version, and we have no place to put docs discussing earlier versions.
Or, even worse, we have a mixed bag of documentation for different versions, creating a very unclear user story.
This prototype includes an end-to-end versioning story, automated by Docusaurus.
Current (v2) docs live under
docs
.Old (v1) docs live under
versioned_docs/version-1
.Most of the documentation has been duplicated between the two versions, but some minor changes have been made to make the docs better line up with the corresponding version of the API.
These changes should be reviewed before being merged into main / deploying the new website.
Search
This branch includes an offline implementation of search.
An offline solution comes with some downsides (slower build, larger bundle), and probably isn't what we want long term.
That said, it is much better than what our current website has (no search whatsoever).
We should come back to this after v1 of our new website.
Help us test!
To see the new site in action, we have published it to a temporary home here: https://lively-bay-0171da81e-preview.westus2.5.azurestaticapps.net/