-
Notifications
You must be signed in to change notification settings - Fork 85
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: Add documentation site using Docusaurus #2358 #2359
base: develop
Are you sure you want to change the base?
Conversation
Implements #2358 |
NOTE: Much of this is boilerplate generated by Docusaurus, if you have any questions about anything reach out! |
This looks great! I think we might want to go a bit further in consolidating docs. Right now it looks like there are duplicates to files like CONTRIBUTING.md and there's a separate docs folder. My worry is that someone might update the docs in either place, leading to lost or conflicting updates. Would you like to propose some consolidation? |
Originally I was gonna delete those but I noticed that at least some are referenced on the website and didn't wanna break things. |
Then I think we should either:
For README.md I think we should definitely do #1, since everyone would expect to find a README, and because the Github project page content comes from this. Some context on this is that it's very easy for the development instructions to fall out of date when somebody makes changes, it's somewhat hard to catch this systematically because internally we always know "the trick" to get things working, and it's always discouraging for new volunteers to follow our instructions and run into a problem because they're out of date. So we want to avoid having two sets of instructions because then we have even more ways to fail to update the instructions correctly. We're also using the Github Wiki for docs and page content. How do you think we should integrate that? One solution here would be to distinguish between developer-facing docs and public-facing docs like the Threat Model, and move all developer-facing docs into Docusaurus, but keep others in the wiki. How does that sound? |
This adds Docusaurus to Quiet, enabling us to have a fully-featured documentation site locally or deployed to production.
I did my best to migrate existing documentation from the markdown files in the repo (including the README) but I'm sure I missed something. I also added some documentation on how Docusaurus works and is configured with links to the official docs.
Styling is a rough first try with Quiet colors but we can certainly iterate on it.
Here are some screenshots so folks can get a feel for the styling/setup:
Pull Request Checklist
(Optional) Mobile checklist
Please ensure you completed the following checks if you did any changes to the mobile package: