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.
Issue(s) Resolved
Developers find it difficult to keep an overview of documentation.
High-level Explanation of PR
This PR adds two options for providing a nice frontend for all of our internal documentation:
/docs
)/docs-nextra
)I chose to include both because both have pros and cons, and I'd like to invite you to have a look and see which feels better.
In my opinion:
I'm a bit torn: on the one hand I like the look of Docusaurus less, but it's slightly more clear to me (Nextra is quite minimalist). Search on both works quite okay, I do know from experience that the docusaurus one uses quite a bit of bandwith (basically downloads the entire documentation at once). Nextra is just a Next app, so it's quite familiar, and we don't need to introduce a bunch of new dependencies as we can sync that with the rest of the app. (the 2300 number there will be even lower if we choose to pick it, as Nextra currently requires Tailwind v4, but we are still on v3). I do think that's a point worth considering, as it'll likely add some time to our builds, as they need to install all dependencies.
The Docusaurus build/dev duration really nice though, Nextra takes ages in comparison.
Both currently output to a fully static site. Nextra could optionally be configured to be dynamic/have Incremental Static Regeneration, but I don't think that's worth it.
Curious what you all think! I will not merge this PR, i'll merge the one we end up going with.
Test Plan
Docusuarus
pnpm --filter docs build && pnpm --filter docs start
(need to build, otherwise search does not work):3005
.pnpm --filter core dev
Nextra
pnpm --filter docs-nextra build && pnpm --filter docs-nextra start
(need to build, otherwise search does not work)localhost:3006
Screenshots (if applicable)
Docusaurus
Nextra
Notes