docs: README showcase

[kowyo-bot]

• Add a screenshot showcase image to README
• Make README shorter + funnier (and remove 技术栈/本地开发 sections)
• Keep docs in docs/ folder

[gemini-code-assist]

Summary of Changes

Hello @kowyo-bot, 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 streamlines the project's main README.md file by making it more concise and user-friendly. It introduces a visual showcase of the application and consolidates all in-depth technical documentation into a dedicated docs/ directory, improving the initial user experience and overall project clarity.

Highlights

• README Content Refinement: The README.md has been significantly shortened and made more engaging, removing verbose technical stack and local development instructions.
• Visual Showcase Integration: A new 'Showcase' section has been added to the README.md, featuring a screenshot to visually represent the application.
• Documentation Centralization: All detailed documentation, previously partially outlined in the README, is now explicitly directed to the docs/ folder for better organization.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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 significantly improves the README.md by making it more concise, user-friendly, and visually appealing with a showcase image. The changes align well with the goal of moving detailed technical information to the docs folder. I have one suggestion to improve the developer experience by providing direct links to the documentation files. Also, since the README is now in English, you might consider translating the documentation in the docs/ folder in a future PR for a more consistent experience.

[gemini-code-assist]

The Docs section is very concise. To improve discoverability for developers and contributors, consider listing the main documentation files with direct links. This provides a quick overview of the available documentation without cluttering the main README.

Suggested change

	See `docs/`.
	See the `docs/` folder for:
	- [Architecture](docs/architecture.md)
	- [Database](docs/database.md)
	- [Deployment](docs/deployment.md)