Back to Details

w-api-docs

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
Update API documentation from the source of truth (TypeBox/Fastify routes, or the repo's documented generator). Never edit generated OpenAPI, generated clients, or generated SQL directly.
  1. Read the API docs MDX and the generator README. Identify the owning source and the generate script in package.json.
  2. Change the owning schema or route, not the generated artifact.
  3. Run the documented generate command. Check drift scripts if the repo has them.
  4. Update adopter MDX only for behavior that changed. Do not invent auth, rate-limit, or versioning policy.
  5. Docs: 
    /w-docs
    if behavior or commands changed.
从事实来源（TypeBox/Fastify 路由，或仓库中记录的生成器）更新 API 文档。切勿直接编辑生成的 OpenAPI、生成的客户端或生成的 SQL。
  1. 阅读 API 文档 MDX 和生成器 README。确定所属来源以及 package.json 中的生成脚本。
  2. 修改所属 schema 或路由，而不是生成产物。
  3. 运行文档中规定的生成命令。如果仓库有 drift 检查脚本，则运行检查。
  4. 仅针对发生变更的行为更新接入方 MDX。不得自行编造 auth、rate-limit 或 versioning 策略。
  5. 文档：如果行为或命令发生变化，更新 
    /w-docs
    。