Contributing to Documentation

We welcome contributions to improve and expand this documentation! Whether you’re fixing typos, clarifying instructions, adding new guides, or updating existing content, your help is appreciated.

How to Contribute

This documentation is hosted on GitHub Pages and generated from Markdown files in the ld-decode-docs repository. All documentation source files are located in the wiki-default/ directory.

If you don’t have the time or the knowledge to work with github, but you spot an issue and still want to help, please use the github issues located in the documentation github repository - make sure you clearly link the page in question and state what’s wrong.

Contributing via Pull Requests

  1. Fork the repository: Visit https://github.com/happycube/ld-decode-docs and click the “Fork” button to create your own copy.

  2. Clone your fork: 
    git clone https://github.com/YOUR-USERNAME/ld-decode-docs.git
cd ld-decode-docs
  3. Create a branch for your changes: 
    git checkout -b improve-documentation

  4. Edit the Markdown files: Navigate to wiki-default/ and edit the relevant .md files using your favorite text editor.

  5. Preview your changes (optional): You can build the site locally using Jekyll to preview your changes before submitting.

  6. Commit your changes: 
    git add .
git commit -m "Description of your changes"
  7. Push to your fork: 
    git push origin improve-documentation
  8. Create a Pull Request: Go to the original repository and click “New Pull Request” to submit your changes for review.

Markdown Formatting

This documentation uses Markdown for formatting. Markdown is a lightweight markup language that’s easy to read and write.

Useful Resources

Questions or Issues?

If you have questions about contributing or encounter any issues, feel free to:

Thank you for helping make this documentation better!