Host Documentation Using GitHub Workflows and MkDocs-Material

[D-Mielewczyk]

Set up GitHub workflows to host project documentation using MkDocs with the Material theme. Additionally, organize existing .md files and update the README to provide clear instructions on how to add new documentation files.

Requirements:

1. Set Up MkDocs with Material Theme:

   • Configure MkDocs to use the Material theme for documentation.
   • Ensure all necessary dependencies and configurations are in place.

2. GitHub Workflows:

   • Create and configure GitHub workflows to automatically build and deploy the MkDocs documentation to GitHub Pages.
   • Ensure the workflow triggers on pushes to the main branch.

3. Organize Existing Documentation:

   • Review and organize any existing .md files to fit within the MkDocs structure.
   • Ensure all files are correctly linked and accessible from the documentation homepage.

4. Update README:

   • Provide clear instructions in the README on how to add new documentation files.
   • Include guidelines on file naming conventions, directory structure, and updating the MkDocs configuration.

Details:

• Ensure the documentation is easy to navigate and visually appealing.
• Provide clear and concise documentation within the README for future contributions.
• Ensure that the GitHub workflow is reliable and consistently deploys the latest documentation updates.

Acceptance Criteria:

• MkDocs with the Material theme is set up and configured correctly.
• GitHub workflows are created and configured to build and deploy documentation automatically.
• Existing .md files are organized and linked appropriately within the documentation.
• The README file includes clear instructions on how to add new documentation files.
• The code and configurations are committed and pushed to the GitHub repository.

Additional Notes:

• Collaborate with team members to ensure the documentation meets project needs.
• Ensure the workflows and documentation setup are thoroughly tested.

[D-Mielewczyk]

Not blocked at all, you can start working on this issue.

[D-Mielewczyk]

Pro100wnick1 Max Nadir reserved this issue, but is not assgined yet.