Adding MKDocs Workflow

[devsetgo]

Pull Request Description: Adding MKDocs Workflow

This pull request introduces a new GitHub Actions workflow to automate the deployment of project documentation using MkDocs. The primary motivation behind this change is to ensure that our documentation is consistently built and published to GitHub Pages whenever changes are made to the main branch.

Key Changes:

1. New Workflow File: A new YAML file (build_mkdocs.yml) has been added to the .github/workflows/ directory. This file defines the steps required to build and deploy the documentation.

2. Documentation Build Process:

   • Python Setup: The workflow sets up a Python environment and installs the necessary dependencies from requirements.txt.
   • Changelog Generation: A script is run to generate the changelog, ensuring that the latest changes are reflected in the documentation.
   • MkDocs Build: The documentation is built using MkDocs, creating a static site.
   • Documentation Deployment: Finally, the built site is deployed to GitHub Pages, making it accessible to users.

3. File Management: The workflow also copies essential files like README.md, CONTRIBUTING.md, and CHANGELOG.md into the docs directory, ensuring that they are included in the documentation site.

Benefits:

• Automation: This workflow automates the documentation deployment process, reducing manual effort and potential human error.
• Up-to-Date Documentation: By automatically updating the documentation whenever changes are pushed to the main branch, we ensure that users always have access to the latest information.
• Improved Visibility: Hosting documentation on GitHub Pages increases its visibility and accessibility for users and contributors.

This addition will significantly enhance our project by providing a streamlined process for maintaining and sharing our documentation.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud