Skip to content

Conversation

@Julusian
Copy link
Member

@Julusian Julusian commented Oct 30, 2025

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)

Screenshot From 2025-10-30 18-26-56 Screenshot From 2025-10-30 18-27-09

@socket-security
Copy link

socket-security bot commented Oct 30, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants