MarlinDocumentation

Overview:

The Marlin Documentation Project is a repository containing the raw documentation for Marlin 3D printer firmware. This documentation is open for contributions, allowing anyone to complete, correct, or create articles. The project is built using Ruby, RubyGems, Jekyll, and Github pages. To contribute, users must fork the repository, clone it locally, and make changes within their own fork before submitting a pull request to the master branch.

Features:

• Open Contribution: The documentation is open for anyone to contribute by completing, correcting, or creating articles.
• Built with Ruby and Jekyll: The project is built using Ruby and Jekyll, ensuring a smooth and customizable documentation experience.
• Github Integration: Users can easily fork the repository, clone it locally, and submit pull requests for their changes to be reviewed and merged.

Installation:

To contribute to the Marlin Documentation Project, follow these steps:

1. Fork the repository on Github by clicking on the “Fork” button.
2. Clone your forked repository to your local machine using the command git clone https://github.com/YourUsername/MarlinDocumentation.git.
3. Create a new branch for your changes using the command git checkout -b branch-name.
4. Make your desired changes or add new documentation files in the _docs folder.
5. Commit your changes using git commit -m "your commit message".
6. Push the changes to your forked repository using git push origin branch-name.
7. Go to the original repository (MarlinFirmware/MarlinDocumentation) on Github and click on “New pull request”.
8. Select your branch and describe your changes, then submit the pull request for review.

Note: Ensure you have Jekyll installed on your system if you want to preview your contributions before submitting them. Instructions for installing Jekyll are available in the next section.

Summary:

The Marlin Documentation Project is an open repository for Marlin 3D printer firmware documentation. Users can contribute by completing, correcting, or creating articles. The project is built using Ruby, RubyGems, Jekyll, and Github pages. To contribute, users must fork the repository, clone it locally, and submit pull requests for their changes to be reviewed.