This is the repository for the ROCKNIX Wiki (created using MkDocs)
It uses the mkdocs-material theme for its layout & styling: https://github.com/squidfunk/mkdocs-material
The ROCKNIX Wiki is located at: rocknix.org
This is not the repository for the ROCKNIX distribution, you can find that here: https://github.com/ROCKNIX/distribution.
You can contribute to the ROCKNIX Wiki in a couple of ways.
Write us a message on the ROCKNIX Discord stating what should be edited or added.
You will need to create a GitHub account to open a Pull Request.
Markdown is a fairly straightforward markup language. If you are not familiar, you can take a quick look at the documents in the docs folder.
Depending on your comfort level with GitHub, you can either use GitHub's web editor to edit any markdown files or you may also clone the repository and edit the markdown files that way.
To edit markdown files in GitHub's web editor, open a document in the docs folder, and click the small pencil icon in the top right. Once you are finished, click Commit changes... GitHub will prompt you to open a Pull Request, which will then be merged once it is reviewed.
Once the PR is merged and reviewed, your changes will automatically be deployed to the website.
If you do choose to clone the repository, you only need to clone the main branch.
Depending on your permission level, when you are finished making edits, either push your changes to main or create a Pull Request. Any changes you make to the markdown files will automatically be pushed to the gh-pages branch and deployed to the website once you have either pushed your changes to main or your Pull Request is approved and merged.
Thank you for contributing!