docs: add mkdocs documentation

[julesbertrand]

Description

Add mkdocs documentation for Roadie. Currently fully based on the README.md and CONTRIBUTING.md files.

Related Issue

#23

Type of Change

• 🚀 New feature (non-breaking change which adds functionality)
• 🔧 Bug fix (non-breaking change which fixes an issue)
• 🥂 Improvement (non-breaking change which improves an existing feature)
• 🔐 Security fix
• 📚 Examples / docs / tutorials / dependencies update
• 💥 Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• I've read the CONTRIBUTING.md guide.
• I've updated the code style using make format-code.
• I've written tests for all new methods and classes that I created.
• I've written the docstring in Google format for all the methods and classes that I used.
• If my change requires a change to docs, I have updated the documentation accordingly.

[github-actions]

PR Analysis

• 🎯 Main theme: Adding mkdocs documentation for the project
• 📝 PR summary: This PR is about adding mkdocs documentation for the project. The documentation is based on the existing README.md and CONTRIBUTING.md files. The PR also includes updates to these files to make them compatible with mkdocs.
• 📌 Type of PR: Documentation
• 🧪 Relevant tests added: No
• ⏱️ Estimated effort to review [1-5]: 2, because the PR is mostly about documentation and does not involve complex code changes.
• 🔒 Security concerns: No security concerns found

PR Feedback

• 💡 General suggestions: The PR is well-structured and the documentation is well-written. The use of mkdocs will make the documentation more accessible and easier to navigate. However, it would be helpful to include a section in the documentation about how to build and view the documentation locally.

• 🤖 Code feedback:

  • relevant file: mkdocs.yml
    suggestion: Consider adding a 'site_description' field to provide a brief description of the project that will appear in search engine results. [medium]
    relevant line: site_name: Vertex Pipelines Deployer

  • relevant file: pyproject.toml
    suggestion: Consider pinning the versions of the new dependencies ('mkdocs' and 'mkdocs-techdocs-core') to avoid potential issues with future versions. [medium]
    relevant line: mkdocs = "^1.5.3"

How to use

To invoke the PR-Agent, add a comment using one of the following commands:
/review [-i]: Request a review of your Pull Request. For an incremental review, which only considers changes since the last review, include the '-i' option.
/describe: Modify the PR title and description based on the contents of the PR.
/improve [--extended]: Suggest improvements to the code in the PR. Extended mode employs several calls, and provides a more thorough feedback.
/ask <QUESTION>: Pose a question about the PR.
/update_changelog: Update the changelog based on the PR's contents.

To edit any configuration parameter from configuration.toml, add --config_path=new_value
For example: /review --pr_reviewer.extra_instructions="focus on the file: ..."
To list the possible configuration parameters, use the /config command.

[julesbertrand]

/review

[github-actions]

PR Analysis

• 🎯 Main theme: Adding mkdocs documentation for the project
• 📝 PR summary: This PR introduces mkdocs documentation for the project. It includes changes to existing files to make them compatible with mkdocs and also adds new files required for the documentation. The documentation is based on the existing README.md and CONTRIBUTING.md files.
• 📌 Type of PR: Documentation
• 🧪 Relevant tests added: No

How to use

To invoke the PR-Agent, add a comment using one of the following commands:
/review [-i]: Request a review of your Pull Request. For an incremental review, which only considers changes since the last review, include the '-i' option.
/describe: Modify the PR title and description based on the contents of the PR.
/improve [--extended]: Suggest improvements to the code in the PR. Extended mode employs several calls, and provides a more thorough feedback.
/ask <QUESTION>: Pose a question about the PR.
/update_changelog: Update the changelog based on the PR's contents.

To edit any configuration parameter from configuration.toml, add --config_path=new_value
For example: /review --pr_reviewer.extra_instructions="focus on the file: ..."
To list the possible configuration parameters, use the /config command.