feat(docs): Update documentation and set up MkDocs#1
Conversation
This commit addresses several documentation-related tasks:
1. **Documentation Update:**
- Corrected Python version inconsistencies across documentation files to align with `pyproject.toml` (Python 3.11+).
- Added a `LICENSE` file (MIT) as referenced in the project's documentation.
2. **New Getting Started Guide:**
- Added a new comprehensive `docs/getting_started.md` to provide a better onboarding experience for new users.
3. **MkDocs HTML Documentation Setup:**
- Created and configured `mkdocs.yml` to generate a static HTML documentation site.
- Reorganized the documentation structure and navigation for clarity.
- Renamed `docs/README.md` to `docs/index.md` to serve as the site's homepage.
- Fixed broken links and warnings to ensure the site builds cleanly.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @tenyi, I'm Gemini Code Assist1! 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 significantly improves the project's documentation by establishing a robust MkDocs-based static site, providing a comprehensive getting started guide, and ensuring consistency in technical details like Python versioning and license information. The changes aim to enhance user onboarding and make the project's documentation more accessible and maintainable.
Highlights
- Documentation Consistency: Standardized Python version references across documentation files to
3.11+to align with the project'spyproject.toml. - License Addition: Added an MIT
LICENSEfile to the repository, as referenced in the project's documentation. - Enhanced Onboarding: Introduced a new, comprehensive
docs/getting_started.mdguide to provide a better onboarding experience for new users. - MkDocs Integration: Set up MkDocs for static HTML documentation generation, including the creation and configuration of
mkdocs.yml, reorganization of the documentation structure and navigation, and renamingdocs/README.mdtodocs/index.mdto serve as the site's homepage. This also involved fixing broken links and warnings to ensure a clean build.
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 or fill out our survey to provide feedback.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request significantly improves the project's documentation by adding a new getting started guide, setting up an MkDocs-based documentation site, and ensuring consistency across files. The changes are well-structured and align with the goal of providing a better user onboarding experience. My review includes a couple of suggestions to replace placeholder repository URLs in the new documentation files to ensure all links and commands are fully functional.
| 首先，使用 `git` 將專案複製到您的本機電腦： | ||
|
|
||
| ```bash | ||
| git clone https://github.com/your-org/chinese-graphrag.git |
There was a problem hiding this comment.
The git clone command uses a placeholder URL with your-org. This should be updated to the actual repository URL to ensure users can clone the project correctly from the documentation.
| repo_url: https://github.com/your-org/chinese-graphrag | ||
| repo_name: your-org/chinese-graphrag |
There was a problem hiding this comment.
The repo_url and repo_name are using a placeholder organization your-org. Please update this to the actual GitHub organization to ensure the repository link on the generated documentation site works correctly.
1 participant
This commit addresses several documentation-related tasks:
Documentation Update:
pyproject.toml(Python 3.11+).LICENSEfile (MIT) as referenced in the project's documentation.New Getting Started Guide:
docs/getting_started.mdto provide a better onboarding experience for new users.MkDocs HTML Documentation Setup:
mkdocs.ymlto generate a static HTML documentation site.docs/README.mdtodocs/index.mdto serve as the site's homepage.