feat: convert docs to docusaurus #3741
Open
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.
This rebuilds the getting-started docs to use docusaurus. This brings a light and dark mode, easier styling, and fixes some quirks we have with urls and scroll positions.
As a follow up, I intend to build an alternate version of these docs that will be published online. This will give the exact same docs but publicly accessible, with no extra dev cost for us to update, and with the exact same styling.
The docs could do with a bit of polishing, which can happen as part of a regular docs update near to the release.
By using docusaurus for the online docs, we should be able to utilise the builtin versioning functionality of docusaurus, so that we can serve docs for not only the latest version. This will only be possible for future releases, unless someone wants to port the old docs across in the same way as these docs have been.
My intention is to bring the other documentation into a single public instance of this, so that we have a single site with all the companion related docs (including module dev)