Contributing to Aisleron Documentation

Thank you for helping improve the Aisleron documentation! This site is built using Jekyll and the “Just the Docs” theme.

License

By contributing to this repository, you agree to license your contributions under the MIT License. This ensures the documentation remains as open and accessible as possible.

Developer Certificate of Origin (DCO)

We use a DCO to certify that contributors have the right to submit their work. You must sign off on every commit.

How to sign off

Add a Signed-off-by line to every commit message. You can automate this by using the -s flag in your git command:

git commit -s -m "Your commit message"

Contribution Requirements

  • Link Integrity: Ensure all internal links (using Jekyll’s link or relative paths) are valid. Broken links will result in build failures.
  • Formatting: Please follow the existing Markdown structure. Use clear, concise language and stick to the “Just the Docs” UI components (like callouts/notes) where appropriate.
  • Images: If adding images, place them in the relevant directory under /assets/images/. All screenshots must follow the naming conventions as per the Aisleron automated screenshot runner. Use descriptive alt-text for accessibility.
  • Corresponding PR: If this documentation update is related to a code change in the main Aisleron repo, please link the corresponding code PR in your description.

AI Usage Policy

  • Content Generation: You may use AI to help draft or refine documentation text. However, you are responsible for the accuracy of the information. You must verify that the instructions actually work and reflect the current state of the software.
  • Images and Artifacts: The use of AI-generated images, icons, or other creative artifacts is strictly prohibited. All assets must be original or provided under a compatible manual license.

Code of Conduct

All participants are expected to follow the project’s Code of Conduct.