add mkdocs

[slashburygin]

No description provided.

[gemini-code-assist]

Summary of Changes

Hello @slashburygin, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a new documentation system for the project by integrating MkDocs with the Material theme. This setup provides a structured and user-friendly platform for project information, covering installation guides, development setup, testing procedures, and general project overview. The changes aim to improve the clarity, maintainability, and accessibility of the project's documentation.

Highlights

• MkDocs Integration: Configured MkDocs to generate and serve project documentation, enhancing accessibility and structure.
• Initial Documentation Content: Added foundational documentation pages including a project overview, FAQ, and a one-pager.
• Development Environment Setup: Integrated MkDocs dependencies into pyproject.toml and created a dedicated tox environment for easily serving the documentation locally.

Changelog

• docs/faq.md
  • Added a new Markdown file for frequently asked questions.
• docs/index.md
  • Added the main documentation landing page, including project overview, installation, development, and testing instructions.
• docs/onepager.md
  • Added a placeholder Markdown file for a project one-pager.
• mkdocs.yml
  • Configured the MkDocs site, specifying the Material theme, language, features, plugins, markdown extensions, and navigation structure.
• pyproject.toml
  • Updated project dependencies to include mkdocs-material and mkdocs-glightbox under a new docs extra.
• tox.ini
  • Added a new docs environment for serving MkDocs documentation with live reload.
  • Adjusted the ruff commands to include both formatting and checking.

Activity

• No human activity (comments, reviews) has been recorded for this pull request yet.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request integrates MkDocs into the project, adding new documentation files for FAQ, an index page, and a one-pager, along with the necessary configuration in mkdocs.yml. It also updates pyproject.toml to include MkDocs dependencies and tox.ini to provide a docs environment for serving the documentation. No security vulnerabilities were found. Overall, this is a good step towards improving project documentation.