Skip to content

docs: 重构全仓库文档规范与扩展多维开源徽章矩阵 - #403

Merged
Qiyuanqiii merged 2 commits into
mainfrom
Qiyuanqiii/docs-refresh-and-badges
Oct 19, 2026
Merged

Qiyuanqiii merged 2 commits into
mainfrom
Qiyuanqiii/docs-refresh-and-badges

Conversation

@Qiyuanqiii

@Qiyuanqiii Qiyuanqiii commented Oct 19, 2026 •

Copy link
Copy Markdown
Member

概述 (Overview)

本 PR 针对项目 Markdown 文档体系进行全面重构与规范化交付,清理原文档中冗长繁复的机器公文腔与装饰性符号,恢复严谨、清晰、专业的开源工程语言风格,并建立对齐顶尖开源项目的多维徽章矩阵。


主要变更 (Key Changes)

1. README.md & README.en.md

  • 内容与结构优化:去除刻板排比,提炼 5 大核心技术特性;将快速开始(预编译下载与源码构建)和模型接入指引(含 ChatGPT 浏览器免 Key 登录)直接置顶前置。
  • 开源徽章矩阵升级:补充 GitHub Actions CI 状态、最新 Release、License、Windows/macOS 平台支持、Go 1.26+、Node.js 24+、React 18、PRs Welcome,以及 Stars、Forks、Issues 等社区指标。
  • 全量技术导航与合规声明:补齐工作区检查点、代码智能、网络存证等核心文档索引表,并规范保留华为 HarmonyOS Sans 字体开源合规声明。
  • 排版去装饰化:全面清理标题与列表项中的装饰性 Emoji,保持严肃优雅的技术排版。

2. CONTRIBUTING.md

  • 清理官僚八股腔:移除原文档中类似法庭辩护的过度免责与防御性公文体。
  • 补全核心工程机制:
    • 详细说明 Go 结构体到 TypeScript DTO 的 OpenAPI 契约生成管线(go run ... api openapi + npm run generate:api + npm run check:api)。
    • 补充敏感凭据与本地数据库测试隔离守则。
    • 补充 Rust 1.97+ Analyzer 可选工具链与桌面端专属 -tags "desktop" 测试参数。

3. web/README.md

  • 清理内部机器日志:移除无上下文的内部状态机流水账。
  • 结构化业务视图矩阵:拆解会话舞台(Stage)、伴侣停靠坞(Companion Dock)、任务输入舱(Composer)、Monaco Diff 逐行审阅等 6 大核心模块。
  • 提供双运行模式:Vite 独立开发代理模式 vs Go 生产托管模式。
  • 国际化支持:提供标准规范的 English Overview。

4. docs/releases/v1.0.0.md

  • 标题与品牌名规范统一为 Universal-Code。

验证 (Verification)

  • npm run check:api:接口一致性通过,无字段或类型漂移。
  • npm run typecheck:tsc -b 0 错误通过。
  • 格式与链接均已校对。

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

Qiyuanqiii and others added 2 commits October 19, 2026 16:10
- 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>
@Qiyuanqiii
Qiyuanqiii merged commit dc6d48e into main Oct 19, 2026
13 checks passed
@Qiyuanqiii
Qiyuanqiii deleted the Qiyuanqiii/docs-refresh-and-badges branch October 19, 2026 08:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant