Repository navigation
docs: 重构全仓库文档规范与扩展多维开源徽章矩阵 - #403
Merged
Merged
Conversation
- Humanize README.md & README.en.md: elevate Quick Start, clarify core features, add browser ChatGPT sign-in, restore full documentation navigation index and third-party font compliance notices. - Upgrade README badge matrix: include CI build status, latest release, license, platform compatibility, Go 1.26+, Node.js 24+, React 18, PRs welcome, and community GitHub metrics. - Refactor CONTRIBUTING.md: remove bureaucratic machine legalese, document Go OpenAPI DTO generation pipeline, credentials/test isolation guidelines, and desktop test flags. - Overhaul web/README.md: replace internal machine log dump with structured functional view matrix, dual execution modes (Vite proxy vs Go hosted), and bilingual developer guidance. - Align v1.0.0 release notes with the Universal-Code brand. Co-authored-by: Google Gemini Code Assist <gemini-code-assist@users.noreply.github.com> Co-authored-by: Gemini Code Assist <https://github.com/gemini-code-assist>
- Remove emoji prefixes across all section titles and lists in README.md, README.en.md, CONTRIBUTING.md, and web/README.md. - Maintain sober, clean, and developer-first documentation aesthetics. Co-authored-by: Google Gemini Code Assist <gemini-code-assist@users.noreply.github.com> Co-authored-by: Gemini Code Assist <https://github.com/gemini-code-assist>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
概述 (Overview)
本 PR 针对项目 Markdown 文档体系进行全面重构与规范化交付,清理原文档中冗长繁复的机器公文腔与装饰性符号,恢复严谨、清晰、专业的开源工程语言风格,并建立对齐顶尖开源项目的多维徽章矩阵。
主要变更 (Key Changes)
1. README.md & README.en.md
2. CONTRIBUTING.md
go run ... api openapi+npm run generate:api+npm run check:api)。-tags "desktop"测试参数。3. web/README.md
4. docs/releases/v1.0.0.md
验证 (Verification)
npm run check:api:接口一致性通过,无字段或类型漂移。npm run typecheck:tsc -b0 错误通过。Co-authored-by: Google Gemini Code Assist gemini-code-assist@users.noreply.github.com
Co-authored-by: Gemini Code Assist https://github.com/gemini-code-assist