Skip to content

docs: 精简 README 并重组使用与维护文档 - #218

Open
yourtion wants to merge 1 commit into
mainfrom
docs/reorganize-project-guides
Open

yourtion wants to merge 1 commit into
mainfrom
docs/reorganize-project-guides

Conversation

@yourtion

Copy link
Copy Markdown
Owner

README 混入了变异测试、CI 基线、发布流程和大量接入细节,首次使用时难以找到可运行的入口。本次将首页从 743 行收敛到 98 行,保留项目介绍、安装、完整 Express 示例和主题导航。

  • 新增四篇使用指南,分别说明 API 定义、框架与 ESM、文档与 SDK、业务 API 测试。
  • 将开发检查、Stryker 命令、增量基线与报告说明集中到 CONTRIBUTING.md;发布流程保留在 RELEASING.md。
  • 迁移指南由 397 行精简为 130 行,按版本倒序保留升级动作,修正 v3.2 handler 签名的适用范围。
  • 更新博客示例和 codegen 说明:补齐子包构建、Zod 安装、takeExample 调用顺序、生成文件与 import 路径;移除失效条目和未实现命令。

本 PR 基于当前 main 的 v3.2.3,仅修改 11 个 Markdown 文件,不依赖尚未合入的 OpenAPI 3 实现。

验证:

  • 检查 11 份文档中的 87 个本地链接与标题锚点。
  • 14 个 TypeScript 示例通过严格类型检查。
  • 使用当前主分支构建产物执行 README 示例,验证 HTTP 200/400、Swagger/Markdown 输出及生成 SDK 的真实请求。
  • 执行 Express、Koa、LeizmWeb 接入片段,均验证 HTTP 200/400。
  • git diff --check 通过。

@codecov

codecov Bot commented Oct 21, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.86%. Comparing base (66d265f) to head (40eac1e).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #218   +/-   ##
=======================================
  Coverage   99.86%   99.86%           
=======================================
  Files          28       28           
  Lines        2962     2962           
  Branches      913      913           
=======================================
  Hits         2958     2958           
  Misses          4        4           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

This branch has not been deployed

No deployments
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