Welcome to the Mage-OS DevDocs repository. If you're here to contribute, or even just to learn, we're thrilled to have you. Below are some guidelines and notes to make your experience with us smooth and beneficial for everyone.
We genuinely mean it when we say every contribution counts. Did you spot a typo? Feel the need to correct a spelling issue? Even these small gestures go a long way in enhancing the quality of our DevDocs. So, don't hesitate. We appreciate your keen eyes!
If there's something you'd like to see documented or feel something's amiss, don't just keep it to yourself. Open up an issue! We're always on the lookout for topics that can add value to Mage-OS DevDocs.
Want to add a new page? Great! Make sure you reference it in the documentation.md which serves as our central navigation. This ensures everyone can find your valuable addition.
Every document you create should start with a # Headline and be followed by a [TOC]. This helps in generating the
Table of Contents. We plan to add help in the form of GitHub Actions to point out potential Layout Flaws, misspellings,
toxic language, non-inclusive language, or similar issues.
Documentation can often feel like a tedious read, but not here. While we aim to be exact and knowledgeable, we also strive to be beginner-friendly. Put on your informative cap, but remember, our readers range from beginners to experts. Aim for clarity and simplicity.
Got questions? Need clarifications? Or just want to chat? Join us on our Discord Server! Hop into the #documentation channel for all things related to the DevDocs. We're a friendly bunch, and someone's always around to help or have a chat. Join the Discord Server
A picture's worth a thousand words! If you'd like to add images to your documentation, please place them in the media directory. This helps keep things neat and organized.
We've designed this repository to be as straightforward as possible. You'll mostly find Markdown files and the media directory here. No fancy structures. No complicated workflows. We like to keep things light and breezy.
A portion of our initial documentation was crafted with the assistance of artificial intelligence. While it has provided valuable insights, not everything has undergone a human review or validation. We're continuously working on enhancing and verifying the content, but if you spot any inaccuracies, do bring it to our attention.
We support GitHub Flavored Markdown, including code blocks with triple backticks. You can also add highlight areas within your documentation.
> **Note**
> Lorem ipsum dolor sit amet, consectetur adipisicing elit. Aut dignissimos dolorum exercitationem fuga maxime
perspiciatis quae sapiente sunt veniam, voluptatum?
> **Warning**
> Lorem ipsum dolor sit amet, consectetur adipisicing elit. Aut dignissimos dolorum exercitationem fuga maxime
perspiciatis quae sapiente sunt veniam, voluptat?For more details, see the GitHub Flavored Markdown documentation.
If you are submitting documentation for the current stable release, submit it to the corresponding branch. For
example, documentation for Mage-OS 2.5.6 would be submitted to the 2.5.6 branch. Documentation intended for the next
release of Mage-OS should be submitted to the main branch.