docs: create docs website

[ArthurKun21]

Pull Request Type

• Chore
• Bugfix
• Feature Implementation
• Documentation
• Other

Related issue

Description

Creation of docs website using mkdocs

Screenshots

Testing

Additional context

[gemini-code-assist]

Summary of Changes

Hello @ArthurKun21, 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 website for the compose-floating-window project using MkDocs. This centralizes project information, making it easier for users to find details on usage, installation, and permissions, and streamlines the README.md by offloading extensive guides to the dedicated site.

Highlights

• Documentation Website Creation: A new documentation site has been set up using MkDocs, providing a dedicated and structured platform for project information.
• MkDocs Configuration: The mkdocs.yaml file has been added to configure the documentation site, including the Material theme, navigation features, search capabilities, and various Markdown extensions for enhanced content presentation.
• README Refinement: The main README.md file has been updated to be more concise, removing detailed usage instructions and instead directing users to the newly created documentation site.
• Markdown Linting/Formatting: The .editorconfig file has been updated to enforce a 4-space indentation for Markdown files, ensuring consistent formatting across documentation.
• Removal of Redundant Documentation: The README_CN.md file, which contained Chinese documentation, has been removed, likely in favor of a more comprehensive, multi-language approach within the new MkDocs site (though multi-language isn't explicitly set up yet, the removal suggests a shift).

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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

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 issue 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]

Warning

Gemini encountered an error creating the review. You can try again by commenting /gemini review.