Contribution Guide
We welcome any and all contributions to the Homelab Community guides.
- Make suggestions or report problems via GitHub issues
- Contribute guides or give feedback on open pull requests
- Ask questions on Discord
How to Contribute
- All changes to this website are managed through GitHub pull requests, so you'll need a GitHub account to contribute.
- You can suggest an edit directly via the
Edit this Page
button at the bottom of each page. - To create a new page, you can use the GitHub browser interface; the content is in
docs
. - Please read about the navbar and sidebars before creating a new page.
- If you want to clone the repository and work locally, you may want to check out the Docusaurus documentation.
You can usenpm start
to run a local development build. This is especially useful when you're working with changes that involve links or sidebars.
Navbar and Sidebars
- The navbar is defined in
docusaurus.config.js
. Any changes require manual configuration. - How to edit the navbar
- The sidebars are defined in
sidebars.js
. - How to edit the sidebar