Skip to content
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

Split the documentation site out from the main website #35

Open
ikeycode opened this issue Jan 18, 2025 · 2 comments
Open

Split the documentation site out from the main website #35

ikeycode opened this issue Jan 18, 2025 · 2 comments

Comments

@ikeycode
Copy link
Member

We have the aging docs subdomain running docusaurus. A while ago we merged docs + main website using the docsy theme - but this has severely impacted usability and generally feels less polished.

We need to split the sites again and move all docs back under one doc-specific site. The floor is open in terms of continuing with docusaurus or not.

@ermo
Copy link
Member

ermo commented Jan 18, 2025

I don't have a strong opinion re. which tool is used.

I only really care that the process for doing updates and publishing them is as sane as we can reasonably make it, which to me means:

  • Make the prerequisites installable via just so the documentation can go "To get started with working on the docs site, run just do-the-thing and you should be able to then build the site locally with (...)."
  • Make it easy to generate (and spell-check/vet) site builds from your local branches (this ties into the above point)
  • That we can live with the way the end solution looks.

@knolljo
Copy link

knolljo commented Jan 18, 2025

I can recommend starlight. It builds a static site and is easy to use with many great features.
CachyOS uses it for example: https://wiki.cachyos.org/

The setup is fairly easy, it just needs a js runtime and an editor.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

3 participants