Merged
Conversation
- 目录编号重整：02-architecture→03-architecture，03-reference→04-reference 04-planning→05-releases，05-audits→06-audits - 新增 docs/00-getting-started/（introduction、philosophy、quick-start） - 新增 docs/02-harness/（overview、feedback、feedforward、STANDARD） - 新增 docs/index.md（VitePress 首页）、docs/changelog.md、docs/public/ - 删除 docs/03-reference/api-reference.md（合并至 04-reference） 删除 docs/04-planning/roadmap.md 和 planning/STANDARD.md - 新增 docs/01-guides/（development-workflow、docker-deployment、environment-setup、testing） - README.md 重写：新增功能说明、Harness Engineering 介绍、项目结构速览 - CHANGELOG.md：修正旧路径引用（05-releases/pr-0.7.0.md 等） - docs/AGENTS.md、docs/README.md、docs/STANDARD.md 同步更新路径引用和内容
03-reference → 04-reference 路径变更同步至脚本和常量： - scripts/generate-error-reference.ts: OUTPUT_PATH 输出路径更新 - src/constants/observability.constant.ts: ERROR_REFERENCE_URL 默认值更新
- 提前设置 WORKDIR（注释补充安全意图说明） - 新增 RUN chown -R node:node /app - 新增 USER node（node:22-slim 内置 uid=1000 的 node 用户） 遵循最小权限原则，符合容器安全最佳实践。
VitePress 配置升级： - 新增任务列表插件（@mdit/plugin-tasklist） - 重命名项目标题为 NestJS Scaffold - 侧边栏增加 Harness Engineering、00-getting-started 等新节 - 重命名导航项：驾驭工程 → Harness Engineering - 移除已废弃的 docs/02-architecture 侧边栏配置 Docker/nginx 基础设施： - Dockerfile.dev/prod：对齐最新 pnpm、VitePress 版本 - nginx.dev/prod.conf：配置调整
- 版本号 0.5.3 → 0.7.4，last-updated 更新至 2026-04-09 - 路径引用更新：docs/02-architecture/ → docs/03-architecture/ - 删除 YAGNI 和防御性编程章节（内容已移至 docs/STANDARD.md） - §3.1 验证序列前置 pnpm format 步骤 - §5.3 新增 pnpm format 检查项 - .github/copilot-instructions.md：架构文档路径更新
- package.json: name nestjs-demo-basic → nestjs-scaffold, version 0.7.3 → 0.7.4 同步升级 minor 依赖（@dotenvx/dotenvx-ops、@nestjs/config、@nestjs/swagger、 @prisma/adapter-pg、@prisma/client、prisma、@nestjs/cli、 @typescript-eslint 系列） - docker-compose.yml: name + APP_NAME 默认值更新 - src/main.ts: Swagger 标题 Nestjs-Demo-Basic API → NestJS Scaffold API figlet banner 同步更新
升级内容（--recursive，锁文件全量重算）： - @dotenvx/dotenvx-ops: ^0.37.4 → ^0.37.8 - @nestjs/config: ^4.0.3 → ^4.0.4 - @nestjs/swagger: ^11.2.6 → ^11.2.7 - @prisma/adapter-pg、@prisma/client、prisma: ^7.6.0 → ^7.7.0 - @nestjs/cli: ^11.0.17 → ^11.0.19 - @typescript-eslint/eslint-plugin、parser: ^8.58.0 → ^8.58.1
- CHANGELOG.md：新增 v0.7.4 条目，涵盖项目重命名、文档重构、 容器安全改进、VitePress 升级、依赖升级等变更 - docs/05-releases/pr-0.7.4.md：新增发布 PR 描述文档
Contributor
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
Walkthrough项目更名为 Changes
Estimated code review effort🎯 4 (Complex) | ⏱️ ~75 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Maiturin
added
documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 16
Note
Due to the large number of review comments, Critical, Major severity comments were prioritized as inline comments.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/01-guides/contributing.md (1)
1-7:⚠️ Potential issue | 🟠 Major同步这篇 active 文档的版本与 frontmatter。
这里的
version还停留在0.7.1，同时缺少inherits和related。在这次0.7.4发布里，这会直接造成版本同步和规范继承漂移。As per coding guidelines, "Ensure frontmatter is complete with: inherits, related, status, version, and last-updated fields correctly filled in all documentation files" and "Update all 'status: active' documentation version fields to match the new version when package.json version field is upgraded".
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/01-guides/contributing.md` around lines 1 - 7, The frontmatter in docs/01-guides/contributing.md is out of sync: update the version field from "0.7.1" to "0.7.4", add the missing frontmatter keys inherits and related (populate them according to the repository's doc inheritance and related pages conventions), and ensure status and last-updated remain correct; specifically edit the top YAML block to include inherits, related, version: "0.7.4", and update last-updated to the current release date so the document conforms to the required frontmatter schema.docs/03-architecture/openapi-enrichment.md (1)
35-53:⚠️ Potential issue | 🟡 Minor为围栏代码块补充语言标识
该段代码块未声明语言，触发 MD040，建议标注为
text（流程图）或实际语言。🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/03-architecture/openapi-enrichment.md` around lines 35 - 53, The fenced code block showing the enrichment steps lacks a language tag (causing MD040); update the block to include a language identifier such as "text" (e.g., change the opening ``` to ```text) so the diagram/flow is treated as plain text; this affects the block that lists SwaggerModule.createDocument, cleanupOpenApiDoc, wrapSuccessResponses, enrichErrorResponses, enrichTagDescriptions, and SwaggerModule.setup.
🟡 Minor comments (26)
docs/05-releases/STANDARD.md-84-88 (1)
84-88:⚠️ Potential issue | 🟡 Minor为围栏代码块补充语言标识，消除 MD040 告警。
当前示例代码块未声明语言，建议标注为
text（或更具体语言）以通过 markdownlint 并提升可读性。建议修复
-``` +```text - **[简短描述]**（`type(scope)`）— [详细说明，必要时包含原因、行为变更对比] - [子要点：具体的技术细节] - [子要点：如有更多细节]-
+text
- PostgreSQL 健康检查参数完善（
fix(ci)）—pg_isready未指定用户和数据库
参数，导致容器初始化期间健康检查即已通过，后续 Job 连接失败
--health-cmd改为pg_isready -U ci_test -d nestjs_demo_basic_test- 新增
--health-start-period 30sAlso applies to: 92-97
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/05-releases/STANDARD.md` around lines 84 - 88, The fenced code blocks shown (the template block starting with "- **[简短描述]**（`type(scope)`）— ..." and the example block starting " - **PostgreSQL 健康检查参数完善**（`fix(ci)`）— ...") lack a language identifier and trigger markdownlint MD040; update each opening fence from ``` to ```text (or a more specific language if appropriate) so they read ```text, ensuring both the template and the PostgreSQL example blocks are annotated (also apply the same fix to the other occurrence noted).docs/05-releases/pr-0.7.2.md-1-1 (1)
1-1:⚠️ Potential issue | 🟡 Minor请移除文件头 BOM 字符。
Line 1 前存在不可见 BOM（
）。建议改为 UTF-8 无 BOM，避免 frontmatter 解析链与差异比较出现不稳定行为。建议修复
---- +---🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/05-releases/pr-0.7.2.md` at line 1, 文件开头包含不可见的 BOM 字符 (U+FEFF) 导致 frontmatter 解析和 diff 行为异常；请在 docs/05-releases/pr-0.7.2.md 中删除文件头的 BOM（第 1 行开头的 ``），并将该文件保存为 UTF-8 无 BOM 编码（即重新保存为 UTF-8 或使用工具移除 U+FEFF），确认 frontmatter（---）是文件的真正开头后重新提交。docs/04-reference/external-resources.md-40-43 (1)
40-43:⚠️ Potential issue | 🟡 Minor重复的二级标题应去重。
## 框架与核心库出现两次，建议保留一个。🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/04-reference/external-resources.md` around lines 40 - 43, 文档中出现重复的二级标题 "## 框架与核心库"；请在 docs/04-reference/external-resources.md 中删除重复的一个，只保留单个二级标题 "## 框架与核心库"（查找该 exact heading 文本以定位），确保移除后的空行或多余空白也被清理以保持文档格式一致。docs/02-harness/feedback.md-83-93 (1)
83-93:⚠️ Potential issue | 🟡 Minor“10 个工作流”与下方表格数量不一致。
Line 83 写 10 个，但表格当前只列出 6 个，建议统一口径（要么补齐条目，要么改文案）。
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/02-harness/feedback.md` around lines 83 - 93, The document states "10 个 GitHub Actions 工作流" but the table only lists six (`ci-feature.yaml`, `ci-dev.yaml`, `cd-dev.yaml`, `ci-release.yaml`, `pr-check-dev.yaml`, `pr-check-prod.yaml`); update the copy and/or table so they match: either change the sentence to the correct count (e.g., "6 个") or add the four missing workflow entries with their triggers and validations to the table so the header and listed workflows are consistent.docs/05-releases/pr-0.7.0.md-1-1 (1)
1-1:⚠️ Potential issue | 🟡 Minor移除文件头 BOM，避免 frontmatter 解析兼容性问题。
Line 1 的
---前有 BOM（），建议去掉，降低 Markdown/frontmatter 解析风险。💡 建议修复
---- +---🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/05-releases/pr-0.7.0.md` at line 1, 文件开头的不可见 BOM 字符（在开头的 ``）导致 frontmatter 起始标记 `---` 前有额外字节，可能破坏 Markdown/frontmatter 解析；请打开文档 `05-releases/pr-0.7.0.md`、移除文件开头的 BOM（确保首字符直接为 `---`），并保存为 UTF-8 无 BOM 编码以避免未来再次出现该问题。docs/03-architecture/auth-module.md-3-11 (1)
3-11:⚠️ Potential issue | 🟡 Minor同步文档元数据到当前发布版本
该文件已被本次 PR 修改，但 frontmatter 仍是
version: "0.7.1"、last-updated: 2026-04-06，与v0.7.4发布窗口不一致。建议一并更新，避免架构文档版本漂移。✏️ 建议修复
-version: "0.7.1" -last-updated: 2026-04-06 +version: "0.7.4" +last-updated: 2026-04-09As per coding guidelines: "Update all 'status: active' documentation version fields to match the new version when package.json version field is upgraded" and "Ensure frontmatter is complete with: inherits, related, status, version, and last-updated fields correctly filled in all documentation files".
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/03-architecture/auth-module.md` around lines 3 - 11, 更新该文档的 frontmatter，确保 status、inherits、related、version 和 last-updated 都与本次发布一致；将 version 字段从 "0.7.1" 改为 "0.7.4" 并把 last-updated 更新为本次发布日期（例如 2026-04-06 → 2026-04-xx），同时核对 inherits 和 related 字段没有遗漏；在保存前检查文件 docs/03-architecture/auth-module.md 的开头 frontmatter 块（查找字段名 inherits, related, status, version, last-updated）以保证格式正确并与包的当前发布版本同步。docs/03-architecture/cicd-deployment.md-3-10 (1)
3-10:⚠️ Potential issue | 🟡 Minor发布文档版本号未同步到 0.7.4
该文件已在本次 PR 中改动，但仍保持
version: "0.7.3"，建议与发布版本统一；同时建议同步last-updated到本次变更日期。✏️ 建议修复
-version: "0.7.3" -last-updated: 2026-04-07 +version: "0.7.4" +last-updated: 2026-04-09As per coding guidelines: "Update all 'status: active' documentation version fields to match the new version when package.json version field is upgraded" and "Ensure frontmatter is complete with: inherits, related, status, version, and last-updated fields correctly filled in all documentation files".
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/03-architecture/cicd-deployment.md` around lines 3 - 10, The document frontmatter still lists version: "0.7.3" and an out‑of‑date last‑updated; update the frontmatter fields so they match the release (set version to "0.7.4"), update last-updated to the current change date (e.g., 2026-04-07 or the actual commit date), and verify the frontmatter includes inherits, related, status: active, version, and last-updated entries unchanged otherwise; ensure no other frontmatter keys are removed and commit the change.docs/01-guides/testing.md-15-26 (1)
15-26:⚠️ Potential issue | 🟡 Minor为目录树代码块补充语言标记
Line 15 的 fenced code block 未指定语言，建议标记为
text以通过 markdownlint。✏️ 建议修复
-``` +```text test/ ├── unit/ # 单元测试 │ ├── app.controller.spec.ts @@ ├── app.e2e-spec.ts └── auth.e2e-spec.ts</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@docs/01-guides/testing.mdaround lines 15 - 26, The fenced code block in
docs/01-guides/testing.md (the directory tree example) is missing a language
tag; update the opening triple-backticks to includetext(i.e., change ``` toyou only modify the opening fence for the block containing the test/ directory tree.docs/02-harness/feedforward.md-36-39 (1)
36-39:⚠️ Potential issue | 🟡 Minor为 fenced code block 指定语言
Line 36 的代码块缺少语言标记，会持续触发 MD040。
✏️ 建议修复
-``` +```text AGENTS.md（根目录） └── docs/AGENTS.md（文档操作专项流程）</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@docs/02-harness/feedforward.mdaround lines 36 - 39, The fenced code block
in docs/02-harness/feedforward.md containing the tree snippet starting with
"AGENTS.md（根目录）" lacks a language tag and triggers MD040; fix it by adding an
explicit language marker (e.g., use "text") to the opening fence so the block
readstext followed by the existing lines and a closingto satisfy the
linter.</details> </blockquote></details> <details> <summary>docs/02-harness/overview.md-32-38 (1)</summary><blockquote> `32-38`: _⚠️ Potential issue_ | _🟡 Minor_ **为示意代码块指定语言** Line 32 的代码块未声明语言，建议改为 `text` 以消除 MD040。 <details> <summary>✏️ 建议修复</summary> ```diff -``` +```text 你的 AI 编程工具 └── 构建方 Harness（系统提示、内置工具、代码检索机制） └── 用户 Harness ← 这是你能控制的部分 @@ ├── 引导层（Feedforward）：告诉 AI 应该怎么做 └── 感知层（Feedback）：告诉 AI 它做得对不对 ``` ``` </details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@docs/02-harness/overview.mdaround lines 32 - 38, Update the fenced code
block containing the diagram starting with "你的 AI 编程工具" so the opening fence
specifies a language (usetext) instead of a bare; that is, change the
code block that contains "你的 AI 编程工具 … 感知层（Feedback）：告诉 AI 它做得对不对" to start withdocs/03-architecture/database.md-4-6 (1)
4-6:⚠️ Potential issue | 🟡 Minor文档版本与 package.json 不同步
与
project-architecture-overview.md相同，版本号应从0.7.1更新至0.7.4。🔧 建议修复
status: active -version: "0.7.1" -last-updated: 2026-04-06 +version: "0.7.4" +last-updated: 2026-04-09As per coding guidelines: "Update all 'status: active' documentation version fields to match the new version when package.json version field is upgraded"
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/03-architecture/database.md` around lines 4 - 6, 当前文档的 YAML 元信息中的 version 字段仍为 "0.7.1"；按规范需要与 package.json 的版本一致。请在 docs/03-architecture/database.md 中将 version 字段从 "0.7.1" 更新为 "0.7.4"（同时保持 status: active 不变），并如适用更新 last-updated 日期以反映变更；确认所有其它“status: active”文档也同步到 package.json 的版本号。docs/00-getting-started/quick-start.md-1-7 (1)
1-7:⚠️ Potential issue | 🟡 MinorFrontmatter 缺少必填字段
根据编码规范，文档的 frontmatter 必须包含
inherits、related、status、version和last-updated字段。当前缺少inherits和related字段。🔧 建议补充
--- title: 快速上手 +inherits: docs/00-getting-started/STANDARD.md status: active version: "0.7.4" last-updated: 2026-04-09 category: guide +related: + - docs/01-guides/environment-setup.md + - docs/01-guides/development-workflow.md + - docs/03-architecture/project-architecture-overview.md ---As per coding guidelines: "Ensure frontmatter is complete with: inherits, related, status, version, and last-updated fields correctly filled in all documentation files"
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/00-getting-started/quick-start.md` around lines 1 - 7, The frontmatter is missing required fields `inherits` and `related`; update the YAML frontmatter block to include both fields (e.g., inherits: <appropriate parent doc or null> and related: [<comma-separated related doc IDs or empty list>]) while keeping `status`, `version`, and `last-updated` unchanged; ensure the keys are top-level in the existing frontmatter and use valid YAML types (string or list) so parsers that read `inherits`, `related`, `status`, `version`, and `last-updated` will find them.docs/01-guides/environment-setup.md-1-7 (1)
1-7:⚠️ Potential issue | 🟡 MinorFrontmatter 缺少必填字段
与
quick-start.md相同，缺少inherits和related字段。🔧 建议补充
--- title: 环境搭建 +inherits: docs/01-guides/STANDARD.md status: active version: "0.7.4" last-updated: 2026-04-09 category: guide +related: + - docs/00-getting-started/quick-start.md + - docs/01-guides/development-workflow.md + - docs/03-architecture/database.md ---As per coding guidelines: "Ensure frontmatter is complete with: inherits, related, status, version, and last-updated fields correctly filled in all documentation files"
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/01-guides/environment-setup.md` around lines 1 - 7, The frontmatter in this document is missing required fields; update the YAML frontmatter to include the missing keys "inherits" and "related" alongside the existing "status", "version", and "last-updated" fields, populating "inherits" and "related" with appropriate values (e.g., matching the patterns used in quick-start.md) and ensuring all fields are correctly formatted and present; verify the frontmatter block still begins/ends with --- and that values for "status", "version", and "last-updated" remain accurate.docs/01-guides/development-workflow.md-1-7 (1)
1-7:⚠️ Potential issue | 🟡 MinorFrontmatter 缺少必填字段且存在 BOM 字符
Frontmatter 缺少
inherits和related字段。另外，文件开头存在 UTF-8 BOM 字符（），建议移除。🔧 建议修复
---- +--- title: 开发工作流 +inherits: docs/01-guides/STANDARD.md status: active version: "0.7.4" last-updated: 2026-04-09 category: guide +related: + - docs/01-guides/environment-setup.md + - docs/01-guides/testing.md + - docs/01-guides/contributing.md ---As per coding guidelines: "Ensure frontmatter is complete with: inherits, related, status, version, and last-updated fields correctly filled in all documentation files"
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/01-guides/development-workflow.md` around lines 1 - 7, The frontmatter is missing required keys and contains a leading UTF-8 BOM; update the YAML frontmatter for this document by removing the BOM character at the very start and adding the required inherits and related fields (alongside the existing title, status, version, last-updated) with appropriate values (e.g., inherits: <parent-doc-slug> and related: [<related-slug-1>, <related-slug-2>]) so the frontmatter includes inherits, related, status, version, and last-updated; ensure the frontmatter block remains valid YAML and there is no invisible BOM before the initial '---'.docs/03-architecture/project-architecture-overview.md-5-6 (1)
5-6:⚠️ Potential issue | 🟡 Minor文档版本与 package.json 不同步
根据编码规范，当
package.json的version字段升级时，所有status: active的文档都应同步更新版本号。当前文档版本为0.7.1，但package.json已升级至0.7.4。🔧 建议修复
status: active -version: "0.7.1" -last-updated: 2026-04-06 +version: "0.7.4" +last-updated: 2026-04-09As per coding guidelines: "Update all 'status: active' documentation version fields to match the new version when package.json version field is upgraded"
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/03-architecture/project-architecture-overview.md` around lines 5 - 6, 当前文档的 front-matter `version:` (值为 0.7.1) 与 `package.json` 中的版本不一致：package.json 已升级为 0.7.4；按照规范，需要将所有 `status: active` 文档的 `version:` 字段同步更新。请在该文档的 YAML front-matter 中将 `version: "0.7.1"` 修改为 `version: "0.7.4"`（只针对 `status: active` 的文档），并在保存前确认 package.json 的 `version` 字段确实为 0.7.4；涉及的标识符为 `version:` 和 `status: active`。docs/01-guides/development-workflow.md-136-141 (1)
136-141:⚠️ Potential issue | 🟡 Minor修正导入路径：
to()函数不在errors/async-result.js中根据代码库验证，
to()函数定义在src/common/utils/operations/async.operation.ts。errors/async-result.js文件不存在。建议更新导入为@/common/utils/index.js或直接从@/common/utils/operations/async.operation.js导入。🔧 建议修复
// 或使用 to() 包装异步操作 -import { to } from '@/common/utils/errors/async-result.js'; +import { to } from '@/common/utils/index.js'; const [err, user] = await to(this.userRepository.findById(id));🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/01-guides/development-workflow.md` around lines 136 - 141, The import for the to() helper is wrong; replace the import statement that currently points to errors/async-result.js with the correct module that exports to() (the async.operation module or the common utils index) so that to() is imported from the module where it is defined (e.g., the operations/async.operation file or the common utils index), ensuring the single import in the example references the actual export of to() used in the code snippet.docs/03-architecture/request-pipeline.md-5-6 (1)
5-6:⚠️ Potential issue | 🟡 Minor版本号与发布日期需要更新
根据编码规范，当 package.json 版本升级时，所有
status: active的文档都应将 version 字段更新为新版本。本 PR 发布 v0.7.4，但此文档的 version 仍为 "0.7.1"，last-updated 为 2026-04-06。由于本 PR 更新了文档中的路径引用（目录重编号），应同步更新元数据。
📝 建议的修复
-version: "0.7.1" -last-updated: 2026-04-06 +version: "0.7.4" +last-updated: 2026-04-09根据编码规范，当 package.json 版本字段升级时，应更新所有
status: active文档的 version 字段至新版本。🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/03-architecture/request-pipeline.md` around lines 5 - 6, 此文档的 frontmatter 元数据未随发布同步：把 version 字段从 "0.7.1" 改为发布版本 "0.7.4"，并将 last-updated 字段更新为本次合并/发布日期（例如 2026-04-09），同时确认文档中任何因目录重编号而更改的路径引用也已同步更新；只修改 request-pipeline.md 的 frontmatter 的 version 和 last-updated 字段并修正文内受目录重编号影响的路径引用，确保该文档仍为 status: active。docs/01-guides/docker-deployment.md-146-149 (1)
146-149:⚠️ Potential issue | 🟡 Minor缺少引用（References）章节
根据编码规范，文档末尾应维护一个"引用"章节，列出所有外部链接。当前文档以"接下来做什么？"章节结尾，缺少
## 引用或## References部分。📝 建议的修复
在文档末尾添加：
## 引用 - [架构设计——CI/CD 常规流水线](../03-architecture/cicd-deployment) - [贡献指南](./contributing) - [架构全览](../03-architecture/project-architecture-overview)根据编码规范，应在文档末尾维护"引用"章节，列出所有外部链接。
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/01-guides/docker-deployment.md` around lines 146 - 149, Add a "## 引用" (or "## References") section at the end of the document after the "接下来做什么？" section and list the three external links currently mentioned inline: the CI/CD architecture link (架构设计——CI/CD 常规流水线), the contributing guide (贡献指南), and the project architecture overview (架构全览); ensure each is a separate bullet and uses the existing relative paths shown in the diff (../03-architecture/cicd-deployment, ./contributing, ../03-architecture/project-architecture-overview) so the document complies with the references convention.docs/01-guides/docker-deployment.md-1-7 (1)
1-7:⚠️ Potential issue | 🟡 MinorFrontmatter 缺少必需字段
根据编码规范，文档的 frontmatter 应包含
inherits和related字段。当前仅有 title、status、version、last-updated 和 category。📝 建议的修复
--- title: Docker 与部署 +inherits: docs/STANDARD.md status: active version: "0.7.4" last-updated: 2026-04-09 category: guide +related: + - docs/03-architecture/cicd-deployment.md + - docs/01-guides/contributing.md ---根据编码规范，应确保 frontmatter 完整性：inherits、related、status、version 和 last-updated 字段必须正确填写。
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/01-guides/docker-deployment.md` around lines 1 - 7, 文档 frontmatter 缺少必需字段：为当前文档的 YAML frontmatter 添加并填充 inherits 和 related 字段，并确认包含 status、version 和 last-updated；具体修改位置是文档最顶部的 frontmatter 块，更新该块以包含 inherits: <适当的父文档或模板标识> 和 related: [<相关文档标识或链接>], 同时核对并填写 status、version、last-updated 的正确值以满足规范。docs/00-getting-started/introduction.md-1-7 (1)
1-7:⚠️ Potential issue | 🟡 MinorFrontmatter 缺少必需字段
根据编码规范，文档的 frontmatter 应包含
inherits和related字段。📝 建议的修复
--- title: 项目简介 +inherits: docs/STANDARD.md status: active version: "0.7.4" last-updated: 2026-04-09 category: guide +related: + - docs/00-getting-started/quick-start.md + - docs/00-getting-started/philosophy.md + - docs/03-architecture/project-architecture-overview.md ---根据编码规范，应确保 frontmatter 完整性：inherits、related、status、version 和 last-updated 字段必须正确填写。
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/00-getting-started/introduction.md` around lines 1 - 7, The frontmatter at the top of the document is missing the required fields `inherits` and `related`; update the YAML frontmatter block (the existing keys `title`, `status`, `version`, `last-updated`, `category`) to include `inherits` and `related` (e.g. `inherits: []` and `related: []` or appropriate strings/lists of slugs), ensuring valid YAML syntax and that `status`, `version`, and `last-updated` remain present and correctly formatted.docs/00-getting-started/introduction.md-147-152 (1)
147-152:⚠️ Potential issue | 🟡 Minor缺少引用（References）章节
根据编码规范，文档末尾应维护"引用"章节列出所有外部链接。
📝 建议的修复
在文档末尾添加：
## 引用 - [快速上手](./quick-start) - [核心理念](./philosophy) - [环境搭建](../01-guides/environment-setup) - [项目架构全览](../03-architecture/project-architecture-overview)根据编码规范，应在文档末尾维护"引用"章节，列出所有外部链接。
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/00-getting-started/introduction.md` around lines 147 - 152, The document is missing a "引用" section at the end; add a new heading "## 引用" and list the four external links referenced in the "接下来做什么？" block (the links with text "快速上手", "核心理念", "环境搭建", "项目架构全览") using the same relative URLs shown (./quick-start, ./philosophy, ../01-guides/environment-setup, ../03-architecture/project-architecture-overview) so all external references are collected at the document footer.AGENTS.md-273-278 (1)
273-278:⚠️ Potential issue | 🟡 Minor给完成报告模板的 fenced block 标注语言。
Line 273 的代码块没有语言标记，当前会持续触发 MD040。这里标成
text就够了。🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@AGENTS.md` around lines 273 - 278, The fenced code block in AGENTS.md (the block starting with the completion report template) lacks a language tag which triggers MD040; update that fenced block by adding a language identifier (e.g., use "text") after the opening triple backticks so the block becomes a fenced code block with a language label, ensuring the linter stops flagging MD040.README.md-21-26 (1)
21-26:⚠️ Potential issue | 🟡 Minor先移除占位链接，再发布 README。
Line 25-26 里的链接目标还是
<!-- 请填写 ... -->占位符，渲染后会留下不可用入口。要么补上真实 URL，要么先改成纯文本说明，避免首页出现死链。🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 21 - 26, The README table contains placeholder HTML comments as link targets for "文档站（main 分支）" and "文档站（dev 分支）" which render as dead links; replace the placeholder link targets in those two table cells by either inserting the real documentation URLs for the main and dev branches or convert the link syntax to plain text (e.g., remove the Markdown link brackets) so the README no longer contains unusable links for the entries "文档站（main 分支）" and "文档站（dev 分支）".docs/01-guides/contributing.md-37-37 (1)
37-37:⚠️ Potential issue | 🟡 Minor把外链补回文末
## 引用。文中还保留了 Conventional Commits 的外链，但文件结尾已经没有
## 引用区块，后续做外链审计时会漏掉这一条。As per coding guidelines, "Maintain a 'References' section at the end of documentation files listing all external links".
Also applies to: 86-95
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/01-guides/contributing.md` at line 37, Add a "## 引用" section at the end of docs/01-guides/contributing.md and restore the external link for "Conventional Commits" into that section; ensure the existing inline occurrence "本项目遵循 [Conventional Commits](https://www.conventionalcommits.org/zh-hans/v1.0.0/) 规范。" remains but the authoritative external URL is listed in the final "## 引用" block, and repeat this fix for the other occurrences noted (lines ~86-95) so all external links are consolidated in the References section.docs/03-architecture/openapi-enrichment.md-190-190 (1)
190-190:⚠️ Potential issue | 🟡 Minor文字质量问题：存在错别字与中英文空格缺失
Line 190 的“示例値从ErrorRegistry”建议改为“示例值从 ErrorRegistry”，避免阅读歧义。
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/03-architecture/openapi-enrichment.md` at line 190, 将文中“示例値从ErrorRegistry”中的错别字和值/中英文空格问题修正为“示例值从 ErrorRegistry”，即把日文/错字“値”改为中文“值”，并在中文与英文名词“ErrorRegistry”之间加空格以提高可读性；在同一段落中搜索并统一类似格式（如“ErrorRegistry”等外文术语前后是否缺空格）并一并修正。CHANGELOG.md-126-131 (1)
126-131:⚠️ Potential issue | 🟡 Minor建议避免改写历史版本条目的语义上下文
Line 126 与 Line 131 将
0.7.1条目中的路径改成了重构后的新目录，可能让读者误以为当时发布即使用了这些路径。建议补充“当前路径映射”说明，或保留当时路径并附注迁移信息。🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CHANGELOG.md` around lines 126 - 131, 在 CHANGELOG.md 的 0.7.1 条目中不要直接改写历史路径语义：针对你在该段落中将 docs/05-releases/pr-0.7.0.md frontmatter 字段及 docs/03-architecture/* 路径替换为重构后新目录的改动，恢复原始发布时的路径描述（即保留当时实际使用的路径），并在该条目中新增一行“当前路径映射 / 迁移说明”说明旧路径与重构后新路径之间的对应关系（例如将旧路径映射到新路径或注明已移动），以避免误导读者；在文中涉及的标识符包括 CHANGELOG.md 的 “0.7.1” 条目、docs/05-releases/pr-0.7.0.md 和 docs/03-architecture/，按此修改并保留历史上下文。
🧹 Nitpick comments (8)
docs/01-guides/environment-setup.md (1)
111-113: 代码块缺少语言标识符静态分析工具提示此处的代码块缺少语言标识符（MD040）。建议添加语言标识以改善文档渲染和语法高亮。
🔧 建议修复
-``` +```text .env.keys → dotenvx → .env.development → 应用获得明文变量</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@docs/01-guides/environment-setup.mdaround lines 111 - 113, The fenced code
block containing ".env.keys → dotenvx → .env.development → 应用获得明文变量" is
missing a language identifier (MD040); update the triple-backtick fence to
include a language tag such as text (e.g., changetotext) so the code
block is properly tagged for syntax highlighting and to satisfy the linter.</details> </blockquote></details> <details> <summary>docs/01-guides/development-workflow.md (1)</summary><blockquote> `89-98`: **代码块缺少语言标识符** 目录结构示例代码块缺少语言标识符（MD040）。 <details> <summary>🔧 建议修复</summary> ```diff -``` +```text src/modules/my-feature/ ├── my-feature.controller.ts # 路由声明与 HTTP 响应 ``` </details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@docs/01-guides/development-workflow.mdaround lines 89 - 98, The markdown
code block showing the directory tree (containing lines like
src/modules/my-feature/ and filenames my-feature.controller.ts,
my-feature.service.ts, my-feature.repository.ts, my-feature.module.ts, and the
dto files) is missing a language identifier; update that fenced code block to
include a language tag (for example, ```text) immediately after the opening
backticks so the snippet satisfies MD040 and renders correctly.</details> </blockquote></details> <details> <summary>package.json (1)</summary><blockquote> `48-49`: **在升级 Prisma 至 7.7.0 后运行必要的迁移和客户端生成命令** Prisma 相关包（`@prisma/adapter-pg`、`@prisma/client`、`prisma`）升级至 `^7.7.0`（最新稳定版本）。升级完成后，请执行以下步骤： 1. 运行 `pnpm db:migrate` 生成迁移文件 2. 运行 `pnpm db:gen-client` 更新客户端类型 3. 验证受影响的 Service 和 DTO 与新版本的类型定义保持一致 <details> <summary>🤖 Prompt for AI Agents</summary> ``` Verify each finding against the current code and only fix it if needed. In `@package.json` around lines 48 - 49, 在将 "@prisma/adapter-pg"、"@prisma/client" 和 "prisma" 升级到 ^7.7.0 后，按顺序运行项目脚本：首先执行 pnpm db:migrate 生成并应用迁移文件，然后执行 pnpm db:gen-client 重新生成 Prisma 客户端类型；完成后检查所有使用 Prisma 的 Service（例如任何包含 PrismaClient 注入或调用的类/函数）和 DTO 类型定义，修正因客户端类型变化导致的类型不匹配或编译错误，确保导入的符号（@prisma/client 的类型/模型名）与新生成的客户端一致。 ``` </details> </blockquote></details> <details> <summary>docs/01-guides/docker-deployment.md (1)</summary><blockquote> `36-44`: **可选：为代码块添加语言标识符** 虽然这是一个表示构建阶段的流程图而非代码，但为 fenced code block 添加语言标识符可以提升 Markdown 规范性。可以使用 `text` 或保留为空。 <details> <summary>♻️ 可选的改进</summary> ```diff -``` +```text 阶段 1（builder）：node:22-slim ``` </details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@docs/01-guides/docker-deployment.mdaround lines 36 - 44, Add a language
identifier to the fenced code block that describes the build stages (the block
starting with "阶段 1（builder）：node:22-slim" and showing the pnpm steps and 阶段 2),
e.g. change the opening fence fromtotext (or leave explicit language
empty if preferred) so the Markdown is more standards-compliant and renders
consistently across parsers.</details> </blockquote></details> <details> <summary>docs/05-releases/pr-0.7.4.md (2)</summary><blockquote> `97-144`: **代码块缺少语言标识符** 文件变更统计使用了无语言标识符的 fenced code block，应添加 `text` 或 `diff` 标识符以提升规范性。 <details> <summary>♻️ 建议的修复</summary> ```diff -``` +```text .github/copilot-instructions.md ← 架构文档路径更新 ``` </details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@docs/05-releases/pr-0.7.4.mdaround lines 97 - 144, The fenced code block in
docs/05-releases/pr-0.7.4.md (the file-change list starting with
".github/copilot-instructions.md ← 架构文档路径更新") is missing a language
identifier; update the opening triple-backticks for that block to include a
language such as text or diff (e.g. changetotext or ```diff) so the
code block is properly annotated and renders consistently.</details> --- `83-94`: **表格前后需要空行** Markdown 规范要求表格前后应有空行分隔。 <details> <summary>♻️ 建议的修复</summary> ```diff - **`build`**：`pnpm update -r` 升级 minor 版本 + | 包 | 旧版本 | 新版本 | |---|---|---| ``` </details> <details> <summary>🤖 Prompt for AI Agents</summary> ``` Verify each finding against the current code and only fix it if needed. In `@docs/05-releases/pr-0.7.4.md` around lines 83 - 94, The markdown table under the "build" section lacks blank lines before and after it; edit the relevant release note entry (the table shown with package versions like `@dotenvx/dotenvx-ops`, `@nestjs/config`, etc.) and insert a single blank line both immediately above the table and immediately below it so the table is properly separated from surrounding text per Markdown rules. ``` </details> </blockquote></details> <details> <summary>docs/00-getting-started/introduction.md (1)</summary><blockquote> `123-145`: **可选：为代码块添加语言标识符** 目录结构树应使用语言标识符（如 `text` 或 `tree`）以提升 Markdown 规范性。 <details> <summary>♻️ 可选的改进</summary> ```diff -``` +```text nestjs-scaffold/ ``` </details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@docs/00-getting-started/introduction.mdaround lines 123 - 145, The code
block showing the project tree (starting with "nestjs-scaffold/") in
introduction.md lacks a language label; update the opening fence fromto a labeled fence liketext ortree so the directory structure is properly rendered (keep the closingintact) — locate the markdown code block that
contains the "nestjs-scaffold/" tree and add the chosen language identifier to
the opening fence.</details> </blockquote></details> <details> <summary>docs/STANDARD.md (1)</summary><blockquote> `1-1`: **建议移除文件头 BOM 字符** Line 1 含 BOM（``），在部分 Markdown/frontmatter 解析器中会引发兼容性问题。建议保存为 UTF-8 无 BOM。 <details> <summary>🤖 Prompt for AI Agents</summary> ``` Verify each finding against the current code and only fix it if needed. In `@docs/STANDARD.md` at line 1, 文件 docs/STANDARD.md 在第1行包含 BOM 字符 (U+FEFF，显示为 ``)，请移除该前导 BOM：打开 docs/STANDARD.md，删除文件开头的 U+FEFF 字符（或在编辑器/IDE 中将文件另存为 “UTF-8 无 BOM”），确认第一字节不再为 BOM 后保存并提交修改以避免前端/解析器兼容性问题。 ``` </details> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against the current code and only fix it if needed.
Inline comments:
In@docs/00-getting-started/philosophy.md:
- Around line 1-7: The frontmatter in philosophy.md is missing the required
inherits and related fields; update the YAML block at the top of the file to add
an "inherits" key pointing to the parent spec identifier (e.g., the primary docs
page or spec slug that this page extends) and a "related" key containing an
array of related document identifiers/slugs; keep existing keys status, version
and last-updated intact and ensure the values use the same formats as other docs
(string for inherits and an array of strings for related) so the page re-enters
the docs inheritance chain.In
@docs/01-guides/testing.md:
- Around line 1-7: The frontmatter for this document (title "测试指南", version
"0.7.4", last-updated "2026-04-09", status "active") is missing the required
inherits and related fields; update the YAML frontmatter at the top of
docs/01-guides/testing.md to include an appropriate inherits key (pointing to
the parent guide or base template) and a related key (array of related doc slugs
or titles), ensuring the frontmatter now contains inherits, related, status,
version, and last-updated entries consistent with project conventions.- Around line 171-173: Update the E2E example assertion to use the correct error
code: replace the current expected value 'AUTH_DUPLICATE_USER' with
'AUTH_USER_DUPLICATE' so it matches AuthExceptionCode.USER_DUPLICATE defined in
src/modules/auth/auth.exception.ts; this ensures the example's
expect(res.body.code) assertion reflects the actual error constant.In
@docs/02-harness/feedback.md:
- Around line 1-7: The document frontmatter is missing required fields and has
an outdated version: add the missing frontmatter keys inherits and related,
ensure status remains active, update version from "0.7.3" to "0.7.4", and
confirm last-updated is set to the current date; make these changes in the
frontmatter block at the top of the file (update the YAML header that contains
title/status/version) so the frontmatter contains inherits, related, status,
version: "0.7.4", and last-updated with the correct date.In
@docs/02-harness/feedforward.md:
- Around line 1-7: The frontmatter is missing required fields and has an
outdated version; update the YAML frontmatter by adding the required inherits
and related fields (e.g., inherits: and related:
[]) and change version from "0.7.3" to "0.7.4", keep status:
active, and ensure last-updated is set to the current date ("2026-04-09"); make
sure the frontmatter remains valid YAML and that the new inherits/related values
reference the correct doc IDs used by the docs system.In
@docs/02-harness/overview.md:
- Around line 1-7: The frontmatter is missing required fields 'inherits' and
'related'; update the document's YAML frontmatter (alongside existing title,
status, version, last-updated, category) to add an appropriate inherits entry
(e.g., the parent doc or base template identifier) and a related list/array of
related doc slugs/IDs so the frontmatter conforms to the project's metadata
schema; ensure the new 'inherits' and 'related' keys use the same naming and
value formats as other docs in the repo (match how other files populate inherits
and related).In
@docs/03-architecture/exception-system.md:
- Around line 1-13: The document "异常系统设计" (frontmatter title: 异常系统设计, version
"0.7.4") is missing the required terminal "References/引用" section; add a
References section at the end of the file listing all external links cited or
used by the document, formatted consistently with other docs (e.g., include link
text, full URL, and brief context), and ensure the new section name uses both
English and Chinese "References / 引用" to match repository conventions referenced
in STANDARD.md.In
@docs/03-architecture/observability.md:
- Around line 3-6: Update the YAML frontmatter by changing the version field
from "0.7.1" to "0.7.4" for this document: locate the line containing the
version key (currently version: "0.7.1") and replace it with version: "0.7.4"
only when the status field is set to status: active to keep the active-doc
versions in sync with the release.In
@docs/03-architecture/openapi-enrichment.md:
- Around line 286-293: Add a "References" section at the end of
docs/03-architecture/openapi-enrichment.md that lists all external links
referenced in the document (e.g., ZodValidationPipe, ZodSerializerInterceptor,
Swagger/OpenAPI spec, any WebSocket/SSE resources mentioned, and any external
pagination/schema references); include full URLs and brief anchor text for each
link, use Markdown link format, and ensure the new section is included in the
document TOC if one exists so it meets the repository guideline to maintain an
external links list.In
@docs/04-reference/external-resources.md:
- Line 75: 在文档末尾新增一个“## 引用”章节，汇总文中出现的所有外部链接（例如 scalar.com 及其它在当前文档中使用的
URL），去重并按字母或出现顺序列出每个条目，格式为链接文本 + 链接地址；在新增段落中也注明链接用途或引用位置（如“API Reference
UI，内嵌于文档站”）以便维护，并确保标题使用中文“## 引用”（或双语“## 引用 / References”）以匹配文档风格。- Around line 1-7: The frontmatter is incomplete and the active document version
is outdated; update the document's frontmatter to include the missing inherits
and related fields, change version from "0.7.3" to "0.7.4", and ensure
last-updated is set to the current date and status remains active; specifically
edit the YAML frontmatter block (the top-level title/status/version/last-updated
section) to add inherits: and related: <appropriate
value(s)>, update version to "0.7.4", and adjust last-updated to the correct
date.In
@docs/04-reference/STANDARD.md:
- Line 12: 将 docs/04-reference/STANDARD.md 的 frontmatter 与主文档保持一致：在文件顶部补全并同步字段
inherits（指向 ../STANDARD.md）、related（列出相关文档标识）、status（保持 "active"）、version（与
package.json 中的版本号一致）以及 last-updated（设置为实际更新日期或与发布版本一致）；确保 related
字段包含应关联的参考条目并且 version 字段精确匹配当前发布版本号以完成与发布版本的对齐（更新时读取 package.json 的 version
值来填充）。In
@docs/05-releases/STANDARD.md:
- Around line 1-8: The frontmatter in docs/05-releases/STANDARD.md is missing
the related field and still lists version "0.7.3" while status is active; update
the frontmatter to include the related key and set version to the current
release (v0.7.4) and ensure last-updated is set to 2026-04-09 and status remains
active; specifically add a related: entry and change version: "0.7.3" ->
version: "0.7.4" in the file's top matter so it matches the other docs and the
package release.In
@docs/changelog.md:
- Around line 1-5: 当前文档的 YAML frontmatter 缺少必填字段：inherits、related、version 和
last-updated（status 已存在）；请在文件顶部的 frontmatter 区块中补齐这些字段并填入合适的值（例如 inherits:
、related: [, ]、version: "x.y.z"、last-updated:
"YYYY-MM-DD"），确保字段名精确匹配并遵循现有文档基线格式以通过验证。In
@docs/README.md:
- Around line 1-7: The frontmatter for docs/README.md is missing the inherits
and related fields; update the YAML frontmatter block (the top --- section) to
include inherits: with the appropriate parent doc(s) (e.g., a list or single
string) and related: with relevant doc paths or identifiers, and ensure the
block retains status, version, and last-updated entries exactly (preserve title,
category, etc.); modify the frontmatter in the README.md file (the top YAML
block) to add the inherits and related keys following the same structure used in
other docs to restore consistent inheritance and linkage.In
@docs/STANDARD.md:
- Around line 199-201: The new rule about using inline link syntax
[text](path)conflicts with the repository requirement to maintain a
"References" section at the end of docs; update the clause that currently
restricts link format (the paragraph introduced around the inline link rule) to
explicitly preserve and require a terminal "References" section listing all
external links, and note that inline links should still be listed and
deduplicated in that "References" section (use the document title or readable
description as display text); ensure this mention references the "References"
heading so maintainers know to keep that section and to include external links
from the document.
Outside diff comments:
In@docs/01-guides/contributing.md:
- Around line 1-7: The frontmatter in docs/01-guides/contributing.md is out of
sync: update the version field from "0.7.1" to "0.7.4", add the missing
frontmatter keys inherits and related (populate them according to the
repository's doc inheritance and related pages conventions), and ensure status
and last-updated remain correct; specifically edit the top YAML block to include
inherits, related, version: "0.7.4", and update last-updated to the current
release date so the document conforms to the required frontmatter schema.In
@docs/03-architecture/openapi-enrichment.md:
- Around line 35-53: The fenced code block showing the enrichment steps lacks a
language tag (causing MD040); update the block to include a language identifier
such as "text" (e.g., change the openingtotext) so the diagram/flow is
treated as plain text; this affects the block that lists
SwaggerModule.createDocument, cleanupOpenApiDoc, wrapSuccessResponses,
enrichErrorResponses, enrichTagDescriptions, and SwaggerModule.setup.
Minor comments:
In@AGENTS.md:
- Around line 273-278: The fenced code block in AGENTS.md (the block starting
with the completion report template) lacks a language tag which triggers MD040;
update that fenced block by adding a language identifier (e.g., use "text")
after the opening triple backticks so the block becomes a fenced code block with
a language label, ensuring the linter stops flagging MD040.In
@CHANGELOG.md:
- Around line 126-131: 在 CHANGELOG.md 的 0.7.1 条目中不要直接改写历史路径语义：针对你在该段落中将
docs/05-releases/pr-0.7.0.md frontmatter 字段及 docs/03-architecture/*
路径替换为重构后新目录的改动，恢复原始发布时的路径描述（即保留当时实际使用的路径），并在该条目中新增一行“当前路径映射 /
迁移说明”说明旧路径与重构后新路径之间的对应关系（例如将旧路径映射到新路径或注明已移动），以避免误导读者；在文中涉及的标识符包括 CHANGELOG.md 的
“0.7.1” 条目、docs/05-releases/pr-0.7.0.md 和 docs/03-architecture/，按此修改并保留历史上下文。In
@docs/00-getting-started/introduction.md:
- Around line 1-7: The frontmatter at the top of the document is missing the
required fieldsinheritsandrelated; update the YAML frontmatter block (the
existing keystitle,status,version,last-updated,category) to
includeinheritsandrelated(e.g.inherits: []andrelated: []or
appropriate strings/lists of slugs), ensuring valid YAML syntax and that
status,version, andlast-updatedremain present and correctly formatted.- Around line 147-152: The document is missing a "引用" section at the end; add a
new heading "## 引用" and list the four external links referenced in the "接下来做什么？"
block (the links with text "快速上手", "核心理念", "环境搭建", "项目架构全览") using the same
relative URLs shown (./quick-start, ./philosophy,
../01-guides/environment-setup,
../03-architecture/project-architecture-overview) so all external references are
collected at the document footer.In
@docs/00-getting-started/quick-start.md:
- Around line 1-7: The frontmatter is missing required fields
inheritsand
related; update the YAML frontmatter block to include both fields (e.g.,
inherits: and related: []) while keepingstatus,version, and
last-updatedunchanged; ensure the keys are top-level in the existing
frontmatter and use valid YAML types (string or list) so parsers that read
inherits,related,status,version, andlast-updatedwill find them.In
@docs/01-guides/contributing.md:
- Line 37: Add a "## 引用" section at the end of docs/01-guides/contributing.md
and restore the external link for "Conventional Commits" into that section;
ensure the existing inline occurrence "本项目遵循 Conventional
Commits 规范。" remains but
the authoritative external URL is listed in the final "## 引用" block, and repeat
this fix for the other occurrences noted (lines ~86-95) so all external links
are consolidated in the References section.In
@docs/01-guides/development-workflow.md:
- Around line 1-7: The frontmatter is missing required keys and contains a
leading UTF-8 BOM; update the YAML frontmatter for this document by removing the
BOM character at the very start and adding the required inherits and related
fields (alongside the existing title, status, version, last-updated) with
appropriate values (e.g., inherits: and related:
[, ]) so the frontmatter includes inherits,
related, status, version, and last-updated; ensure the frontmatter block remains
valid YAML and there is no invisible BOM before the initial '---'.- Around line 136-141: The import for the to() helper is wrong; replace the
import statement that currently points to errors/async-result.js with the
correct module that exports to() (the async.operation module or the common utils
index) so that to() is imported from the module where it is defined (e.g., the
operations/async.operation file or the common utils index), ensuring the single
import in the example references the actual export of to() used in the code
snippet.In
@docs/01-guides/docker-deployment.md:
- Around line 146-149: Add a "## 引用" (or "## References") section at the end of
the document after the "接下来做什么？" section and list the three external links
currently mentioned inline: the CI/CD architecture link (架构设计——CI/CD 常规流水线), the
contributing guide (贡献指南), and the project architecture overview (架构全览); ensure
each is a separate bullet and uses the existing relative paths shown in the diff
(../03-architecture/cicd-deployment, ./contributing,
../03-architecture/project-architecture-overview) so the document complies with
the references convention.- Around line 1-7: 文档 frontmatter 缺少必需字段：为当前文档的 YAML frontmatter 添加并填充 inherits
和 related 字段，并确认包含 status、version 和 last-updated；具体修改位置是文档最顶部的 frontmatter
块，更新该块以包含 inherits: <适当的父文档或模板标识> 和 related: [<相关文档标识或链接>], 同时核对并填写
status、version、last-updated 的正确值以满足规范。In
@docs/01-guides/environment-setup.md:
- Around line 1-7: The frontmatter in this document is missing required fields;
update the YAML frontmatter to include the missing keys "inherits" and "related"
alongside the existing "status", "version", and "last-updated" fields,
populating "inherits" and "related" with appropriate values (e.g., matching the
patterns used in quick-start.md) and ensuring all fields are correctly formatted
and present; verify the frontmatter block still begins/ends with --- and that
values for "status", "version", and "last-updated" remain accurate.In
@docs/01-guides/testing.md:
- Around line 15-26: The fenced code block in docs/01-guides/testing.md (the
directory tree example) is missing a language tag; update the opening
triple-backticks to includetext(i.e., changetotext) so markdownlint
passes and the tree is treated as plain text; ensure you only modify the opening
fence for the block containing the test/ directory tree.In
@docs/02-harness/feedback.md:
- Around line 83-93: The document states "10 个 GitHub Actions 工作流" but the table
only lists six (ci-feature.yaml,ci-dev.yaml,cd-dev.yaml,
ci-release.yaml,pr-check-dev.yaml,pr-check-prod.yaml); update the copy
and/or table so they match: either change the sentence to the correct count
(e.g., "6 个") or add the four missing workflow entries with their triggers and
validations to the table so the header and listed workflows are consistent.In
@docs/02-harness/feedforward.md:
- Around line 36-39: The fenced code block in docs/02-harness/feedforward.md
containing the tree snippet starting with "AGENTS.md（根目录）" lacks a language tag
and triggers MD040; fix it by adding an explicit language marker (e.g., use
"text") to the opening fence so the block readstext followed by the existing lines and a closingto satisfy the linter.In
@docs/02-harness/overview.md:
- Around line 32-38: Update the fenced code block containing the diagram
starting with "你的 AI 编程工具" so the opening fence specifies a language (use
text) instead of a bare; that is, change the code block that contains "你的
AI 编程工具 … 感知层（Feedback）：告诉 AI 它做得对不对" to start with ```text to satisfy the MD040
lint rule.In
@docs/03-architecture/auth-module.md:
- Around line 3-11: 更新该文档的 frontmatter，确保 status、inherits、related、version 和
last-updated 都与本次发布一致；将 version 字段从 "0.7.1" 改为 "0.7.4" 并把 last-updated
更新为本次发布日期（例如 2026-04-06 → 2026-04-xx），同时核对 inherits 和 related 字段没有遗漏；在保存前检查文件
docs/03-architecture/auth-module.md 的开头 frontmatter 块（查找字段名 inherits, related,
status, version, last-updated）以保证格式正确并与包的当前发布版本同步。In
@docs/03-architecture/cicd-deployment.md:
- Around line 3-10: The document frontmatter still lists version: "0.7.3" and an
out‑of‑date last‑updated; update the frontmatter fields so they match the
release (set version to "0.7.4"), update last-updated to the current change date
(e.g., 2026-04-07 or the actual commit date), and verify the frontmatter
includes inherits, related, status: active, version, and last-updated entries
unchanged otherwise; ensure no other frontmatter keys are removed and commit the
change.In
@docs/03-architecture/database.md:
- Around line 4-6: 当前文档的 YAML 元信息中的 version 字段仍为 "0.7.1"；按规范需要与 package.json
的版本一致。请在 docs/03-architecture/database.md 中将 version 字段从 "0.7.1" 更新为
"0.7.4"（同时保持 status: active 不变），并如适用更新 last-updated 日期以反映变更；确认所有其它“status:
active”文档也同步到 package.json 的版本号。In
@docs/03-architecture/openapi-enrichment.md:
- Line 190: 将文中“示例値从ErrorRegistry”中的错别字和值/中英文空格问题修正为“示例值从
ErrorRegistry”，即把日文/错字“値”改为中文“值”，并在中文与英文名词“ErrorRegistry”之间加空格以提高可读性；在同一段落中搜索并统一类似格式（如“ErrorRegistry”等外文术语前后是否缺空格）并一并修正。In
@docs/03-architecture/project-architecture-overview.md:
- Around line 5-6: 当前文档的 front-matter
version:(值为 0.7.1) 与package.json
中的版本不一致：package.json 已升级为 0.7.4；按照规范，需要将所有status: active文档的version:
字段同步更新。请在该文档的 YAML front-matter 中将version: "0.7.1"修改为version: "0.7.4"（只针对
status: active的文档），并在保存前确认 package.json 的version字段确实为 0.7.4；涉及的标识符为
version:和status: active。In
@docs/03-architecture/request-pipeline.md:
- Around line 5-6: 此文档的 frontmatter 元数据未随发布同步：把 version 字段从 "0.7.1" 改为发布版本
"0.7.4"，并将 last-updated 字段更新为本次合并/发布日期（例如
2026-04-09），同时确认文档中任何因目录重编号而更改的路径引用也已同步更新；只修改 request-pipeline.md 的 frontmatter
的 version 和 last-updated 字段并修正文内受目录重编号影响的路径引用，确保该文档仍为 status: active。In
@docs/04-reference/external-resources.md:
- Around line 40-43: 文档中出现重复的二级标题 "## 框架与核心库"；请在
docs/04-reference/external-resources.md 中删除重复的一个，只保留单个二级标题 "## 框架与核心库"（查找该 exact
heading 文本以定位），确保移除后的空行或多余空白也被清理以保持文档格式一致。In
@docs/05-releases/pr-0.7.0.md:
- Line 1: 文件开头的不可见 BOM 字符（在开头的
）导致 frontmatter 起始标记---前有额外字节，可能破坏
Markdown/frontmatter 解析；请打开文档05-releases/pr-0.7.0.md、移除文件开头的 BOM（确保首字符直接为
---），并保存为 UTF-8 无 BOM 编码以避免未来再次出现该问题。In
@docs/05-releases/pr-0.7.2.md:
- Line 1: 文件开头包含不可见的 BOM 字符 (U+FEFF) 导致 frontmatter 解析和 diff 行为异常；请在
docs/05-releases/pr-0.7.2.md 中删除文件头的 BOM（第 1 行开头的），并将该文件保存为 UTF-8 无 BOM
编码（即重新保存为 UTF-8 或使用工具移除 U+FEFF），确认 frontmatter（---）是文件的真正开头后重新提交。In
@docs/05-releases/STANDARD.md:
- Around line 84-88: The fenced code blocks shown (the template block starting
with "- [简短描述]（type(scope)）— ..." and the example block starting " -
PostgreSQL 健康检查参数完善（fix(ci)）— ...") lack a language identifier and trigger
markdownlint MD040; update each opening fence fromtotext (or a more
specific language if appropriate) so they read ```text, ensuring both the
template and the PostgreSQL example blocks are annotated (also apply the same
fix to the other occurrence noted).In
@README.md:
- Around line 21-26: The README table contains placeholder HTML comments as link
targets for "文档站（main 分支）" and "文档站（dev 分支）" which render as dead links; replace
the placeholder link targets in those two table cells by either inserting the
real documentation URLs for the main and dev branches or convert the link syntax
to plain text (e.g., remove the Markdown link brackets) so the README no longer
contains unusable links for the entries "文档站（main 分支）" and "文档站（dev 分支）".
Nitpick comments:
In@docs/00-getting-started/introduction.md:
- Around line 123-145: The code block showing the project tree (starting with
"nestjs-scaffold/") in introduction.md lacks a language label; update the
opening fence fromto a labeled fence liketext ortree so the directory structure is properly rendered (keep the closingintact) — locate
the markdown code block that contains the "nestjs-scaffold/" tree and add the
chosen language identifier to the opening fence.In
@docs/01-guides/development-workflow.md:
- Around line 89-98: The markdown code block showing the directory tree
(containing lines like src/modules/my-feature/ and filenames
my-feature.controller.ts, my-feature.service.ts, my-feature.repository.ts,
my-feature.module.ts, and the dto files) is missing a language identifier;
update that fenced code block to include a language tag (for example, ```text)
immediately after the opening backticks so the snippet satisfies MD040 and
renders correctly.In
@docs/01-guides/docker-deployment.md:
- Around line 36-44: Add a language identifier to the fenced code block that
describes the build stages (the block starting with "阶段 1（builder）：node:22-slim"
and showing the pnpm steps and 阶段 2), e.g. change the opening fence from ``` tostandards-compliant and renders consistently across parsers. In `@docs/01-guides/environment-setup.md`: - Around line 111-113: The fenced code block containing ".env.keys → dotenvx → .env.development → 应用获得明文变量" is missing a language identifier (MD040); update the triple-backtick fence to include a language tag such as text (e.g., change ``` to ```text) so the code block is properly tagged for syntax highlighting and to satisfy the linter. In `@docs/05-releases/pr-0.7.4.md`: - Around line 97-144: The fenced code block in docs/05-releases/pr-0.7.4.md (the file-change list starting with ".github/copilot-instructions.md ← 架构文档路径更新") is missing a language identifier; update the opening triple-backticks for that block to include a language such as text or diff (e.g. change ``` to ```text or ```diff) so the code block is properly annotated and renders consistently. - Around line 83-94: The markdown table under the "build" section lacks blank lines before and after it; edit the relevant release note entry (the table shown with package versions like `@dotenvx/dotenvx-ops`, `@nestjs/config`, etc.) and insert a single blank line both immediately above the table and immediately below it so the table is properly separated from surrounding text per Markdown rules. In `@docs/STANDARD.md`: - Line 1: 文件 docs/STANDARD.md 在第1行包含 BOM 字符 (U+FEFF，显示为 ``)，请移除该前导 BOM：打开 docs/STANDARD.md，删除文件开头的 U+FEFF 字符（或在编辑器/IDE 中将文件另存为 “UTF-8 无 BOM”），确认第一字节不再为 BOM 后保存并提交修改以避免前端/解析器兼容性问题。 In `@package.json`: - Around line 48-49: 在将 "@prisma/adapter-pg"、"@prisma/client" 和 "prisma" 升级到 ^7.7.0 后，按顺序运行项目脚本：首先执行 pnpm db:migrate 生成并应用迁移文件，然后执行 pnpm db:gen-client 重新生成 Prisma 客户端类型；完成后检查所有使用 Prisma 的 Service（例如任何包含 PrismaClient 注入或调用的类/函数）和 DTO 类型定义，修正因客户端类型变化导致的类型不匹配或编译错误，确保导入的符号（@prisma/client 的类型/模型名）与新生成的客户端一致。🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID:
d84ea422-29cf-4a40-b809-19f7d57298bc⛔ Files ignored due to path filters (2)
docs/public/img/logo-small.svgis excluded by!**/*.svgpnpm-lock.yamlis excluded by!**/pnpm-lock.yaml📒 Files selected for processing (56)
.github/copilot-instructions.mdAGENTS.mdCHANGELOG.mdDockerfileREADME.mddocker-compose.ymldocs/00-getting-started/introduction.mddocs/00-getting-started/philosophy.mddocs/00-getting-started/quick-start.mddocs/01-guides/contributing.mddocs/01-guides/development-workflow.mddocs/01-guides/docker-deployment.mddocs/01-guides/environment-setup.mddocs/01-guides/testing.mddocs/02-harness/STANDARD.mddocs/02-harness/feedback.mddocs/02-harness/feedforward.mddocs/02-harness/overview.mddocs/03-architecture/STANDARD.mddocs/03-architecture/auth-module.mddocs/03-architecture/cicd-deployment.mddocs/03-architecture/database.mddocs/03-architecture/exception-system.mddocs/03-architecture/observability.mddocs/03-architecture/openapi-enrichment.mddocs/03-architecture/project-architecture-overview.mddocs/03-architecture/request-pipeline.mddocs/03-architecture/route-decorator.mddocs/03-reference/api-reference.mddocs/04-planning/STANDARD.mddocs/04-planning/roadmap.mddocs/04-reference/STANDARD.mddocs/04-reference/error-reference.mddocs/04-reference/external-resources.mddocs/05-releases/STANDARD.mddocs/05-releases/pr-0.7.0.mddocs/05-releases/pr-0.7.1.mddocs/05-releases/pr-0.7.2.mddocs/05-releases/pr-0.7.3.mddocs/05-releases/pr-0.7.4.mddocs/06-audits/STANDARD.mddocs/AGENTS.mddocs/README.mddocs/STANDARD.mddocs/changelog.mddocs/index.mdpackage.jsonscripts/generate-error-reference.tssrc/constants/observability.constant.tssrc/main.tswebsite/.vitepress/config.tswebsite/Dockerfile.devwebsite/Dockerfile.prodwebsite/nginx.dev.confwebsite/nginx.prod.confwebsite/package.json💤 Files with no reviewable changes (3)
- docs/04-planning/STANDARD.md
- docs/03-reference/api-reference.md
- docs/04-planning/roadmap.md
Contributor
There was a problem hiding this comment.
Actionable comments posted: 5
🧹 Nitpick comments (1)
docs/00-getting-started/about.md (1)
25-25: 中文表述可微调以提升语法自然度“致以诚挚的感谢”建议改为“诚挚地感谢”，更自然。
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/00-getting-started/about.md` at line 25, Locate the sentence "本项目站在以下优秀开源项目的肩膀上构建，向它们的作者和社区致以诚挚的感谢：" and replace "致以诚挚的感谢" with the more natural phrasing "诚挚地感谢", resulting in "本项目站在以下优秀开源项目的肩膀上构建，向它们的作者和社区诚挚地感谢：".
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/00-getting-started/about.md`:
- Line 19: Update the two external links that still point to the old repository
URL "https://github.com/gdmuna/nestjs-demo-basic" in the docs (one occurrence
shown and another at the indicated line) to the project's new GitHub repository
URL; replace the old URL with the new repo URL everywhere it appears, keeping
the link text and local link to /guide/contributing unchanged, and verify both
instances render correctly after the change.
- Around line 1-7: The frontmatter block is missing required metadata fields;
add the keys inherits and related to the existing frontmatter (alongside the
present status, version, last-updated, title, category) so the document
satisfies the metadata completeness rule; ensure inherits is set to the
appropriate parent doc identifier (or an empty list/string if none) and related
contains an array of related doc identifiers (or an empty array), keeping
existing values for title/status/version/last-updated unchanged.
- Line 59: 在 about.md 文档末尾新增一个 “References” 小节，统一列出文中出现的所有外部链接（例如 MIT 许可证链接
https://github.com/gdmuna/nestjs-demo-basic/blob/main/LICENSE
及其它文中链接），每项包含短描述和完整 URL，以便后续审计与维护；确保格式统一（如有序或无序列表）并将该小节置于文档结尾以符合文档规范。
In `@website/Dockerfile.dev`:
- Around line 33-35: The dev image currently allows VITE_BASE_PATH to be
overridden via ARG/ENV (ARG VITE_BASE_PATH / ENV VITE_BASE_PATH) while
website/nginx.dev.conf only serves the /dev prefix and the HEALTHCHECK targets
/, causing route/resource 404s if VITE_BASE_PATH is changed; fix by locking the
dev contract: remove or hardcode ARG/ENV so VITE_BASE_PATH is fixed to /dev/ in
Dockerfile.dev (or explicitly ignore external overrides), or alternatively make
nginx.dev.conf read the base path (templating or envsubst) and add matching
location blocks, and update the HEALTHCHECK (lines around the existing
healthcheck) to probe the configured VITE_BASE_PATH health endpoint instead of
/. Ensure consistency between ARG VITE_BASE_PATH / ENV VITE_BASE_PATH,
nginx.dev.conf, and the HEALTHCHECK.
In `@website/nginx.prod.conf`:
- Around line 27-36: Add 301 canonical redirects for the bare paths and tighten
the SPA location: create two exact-match redirects that return 301 for "/prod"
-> "/prod/" and for "/prod/api-reference" -> "/prod/api-reference/" so requests
without trailing slashes are normalized, and change the SPA block from the
prefix location named "location /prod" to the more specific "location /prod/" so
it only matches the intended SPA subtree (leave the existing "location
/prod/api-reference/" for the API docs intact); ensure the redirects occur
before the SPA location so they take precedence.
---
Nitpick comments:
In `@docs/00-getting-started/about.md`:
- Line 25: Locate the sentence "本项目站在以下优秀开源项目的肩膀上构建，向它们的作者和社区致以诚挚的感谢：" and
replace "致以诚挚的感谢" with the more natural phrasing "诚挚地感谢", resulting in
"本项目站在以下优秀开源项目的肩膀上构建，向它们的作者和社区诚挚地感谢：".
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: f2c27426-f7d4-448b-8eb7-0cebaf52cd32
⛔ Files ignored due to path filters (2)
docs/public/img/logo-default.pngis excluded by!**/*.pngdocs/public/img/logo-shadowed-cut.pngis excluded by!**/*.png
📒 Files selected for processing (12)
README.mddocs/00-getting-started/about.mddocs/04-reference/CHANGELOG.mddocs/04-reference/external-resources.mddocs/index.mddocs/public/img/logo-default-2x-cut.webpwebsite/.vitepress/config.tswebsite/.vitepress/theme/style.csswebsite/Dockerfile.devwebsite/Dockerfile.prodwebsite/api-reference/index.htmlwebsite/nginx.prod.conf
✅ Files skipped from review due to trivial changes (4)
- docs/04-reference/CHANGELOG.md
- website/api-reference/index.html
- website/.vitepress/theme/style.css
- docs/index.md
🚧 Files skipped from review as they are similar to previous changes (4)
- website/Dockerfile.prod
- README.md
- docs/04-reference/external-resources.md
- website/.vitepress/config.ts
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/05-releases/pr-0.7.4.md`:
- Around line 1-7: The frontmatter block in the release note is missing required
metadata fields; update the YAML header in pr-0.7.4.md (the top --- block) to
include the required keys inherits, related, status, and last-updated in
addition to the existing version/title/base/branch/date; populate them with
appropriate values (e.g., inherits: null or a parent doc identifier, related: an
array or empty list, status: draft|stable|published as appropriate,
last-updated: ISO date) so the docs/ files comply with the coding guidelines.
- Around line 114-161: The fenced code block in pr-0.7.4.md (the block starting
with ".github/copilot-instructions.md ← 架构文档路径更新") is missing a language tag
and triggers MD040; update that block to start with a language marker (e.g.,
```text or ```bash) so the linter recognizes it, ensuring the block content (the
file list lines like ".github/copilot-instructions.md", "AGENTS.md",
"CHANGELOG.md", etc.) remains unchanged.
- Around line 100-103: The Markdown table after the "**`build`**：`pnpm update
-r` 升级 minor 版本" line is missing surrounding blank lines which triggers MD058;
add a blank line immediately before the table (so there's an empty line between
the paragraph "**`build`**：`pnpm update -r` 升级 minor 版本" and the table starting
with "| 包 | 旧版本 | 新版本 |"), and also ensure a blank line after the table (after
the row with `@dotenvx/dotenvx-ops | ^0.37.4 | ^0.37.8`) to satisfy
markdownlint.
- Around line 171-179: The file ends with the checklist header "## 检查清单" but is
missing the required closing "## 引用" (References) section; add a new "## 引用"
header at the end of docs/05-releases/pr-0.7.4.md and list any external links
referenced in the release notes (e.g., CHANGELOG, VitePress, package manager
docs, or other external resources mentioned elsewhere in the file), ensuring the
References section appears after the checklist and uses the same language/format
as other docs (Chinese "## 引用" or bilingual "## 引用 / References") for
consistency.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: f0487ffb-4ca1-43b0-962a-0551c155773b
📒 Files selected for processing (2)
CHANGELOG.mddocs/05-releases/pr-0.7.4.md
🚧 Files skipped from review as they are similar to previous changes (1)
- CHANGELOG.md
- introduction.md: reframe as learning project, remove 'professional developer' positioning - philosophy.md: add next-steps section - quick-start.md: add environment setup link to next-steps - README.md: add learning-project context - 00-getting-started/about.md: remove (canonical about page moved to 04-reference) - exception-system.md: change title and heading to '异常系统' - openapi-enrichment.md, route-decorator.md: minor title alignment
…in nginx - Dockerfile.dev/prod: add COPY .git ./.git in builder stage for VitePress lastUpdated - nginx.dev.conf/nginx.prod.conf: add absolute_redirect off before 301 redirects to prevent port leakage when behind a reverse proxy
Rename directory to match its actual role (appendix) and update all references: - website/.vitepress/config.ts: rewrites rule - scripts/generate-error-reference.ts: output path comment and constant - src/constants/observability.constant.ts: ERROR_REFERENCE_URL default - AGENTS.md: inheritance chain tree diagram - docs/README.md: section heading and table links - docs/STANDARD.md: frontmatter related list, tree, category table, index table - docs/04-appendix/STANDARD.md: self-reference in body text
Add :::warning block at end of 02-harness/overview.md explaining the current implementation gaps: architectural dependency enforcement not automated, AI code review agent not yet implemented, mutation testing and drift detection not yet introduced.
- CHANGELOG.md: add '📁 文档重构（后续增补）' section for 04-reference rename and harness note - docs/05-releases/pr-0.7.4.md: add matching section + update file changes summary
- Remove logo-default.png - Add gdmuna-logo_gradient-cut.png (used as site logo and favicon) - Add gdmuna-logo_gradient.svg (SVG source)
Contributor
There was a problem hiding this comment.
Actionable comments posted: 8
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
website/.vitepress/config.ts (1)
151-161:⚠️ Potential issue | 🟠 Major仓库链接仍指向旧仓库名，建议统一更新
Line [151]、Line [155]、Line [160] 仍使用
nestjs-demo-basic，与本次品牌/仓库命名不一致，文档站会持续跳转到旧地址。建议修改
- socialLinks: [{ icon: 'github', link: 'https://github.com/gdmuna/nestjs-demo-basic' }], + socialLinks: [{ icon: 'github', link: 'https://github.com/gdmuna/NestJS-Scaffold' }], @@ - '基于 <a href="https://github.com/gdmuna/nestjs-demo-basic/blob/main/LICENSE">MIT 许可</a> 发布', + '基于 <a href="https://github.com/gdmuna/NestJS-Scaffold/blob/main/LICENSE">MIT 许可</a> 发布', @@ - pattern: 'https://github.com/gdmuna/nestjs-demo-basic/edit/main/docs/:path', + pattern: 'https://github.com/gdmuna/NestJS-Scaffold/edit/main/docs/:path',🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@website/.vitepress/config.ts` around lines 151 - 161, Update all hard-coded references to the old repository name "gdmuna/nestjs-demo-basic" to the new/current repository name in the Vitepress config: replace the URL in socialLinks[0].link, the LICENSE link inside footer.message, the href in footer.copyright anchor, and the editLink.pattern so documentation edit links point to the correct repo; ensure the new repo name is used consistently in those three places (socialLinks, footer.message/footer.copyright, editLink).
♻️ Duplicate comments (9)
docs/05-releases/pr-0.7.4.md (4)
1-7:⚠️ Potential issue | 🟠 Majorfrontmatter 仍缺少必填字段
Line [1]-[7] 目前缺少
inherits、related、status、last-updated，该问题与此前评审一致，仍未修复。As per coding guidelines "
docs/**/*.md: Ensure frontmatter is complete with fields: inherits, related, status, version, last-updated".🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/05-releases/pr-0.7.4.md` around lines 1 - 7, The frontmatter in the release doc (the YAML block with title/version/base/branch/date) is missing required fields; update the frontmatter for this file to include the required keys inherits, related, status, and last-updated (in addition to the existing title, version, base, branch, date) and populate them with appropriate values per the docs guideline; ensure the frontmatter remains valid YAML and follows the project's docs template for release pages so automated checks pass.
119-119:⚠️ Potential issue | 🟡 Minor代码块缺少语言标记（MD040）
Line [119] 建议将围栏代码块改为 ```text（或其他匹配语言）以通过 lint。
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/05-releases/pr-0.7.4.md` at line 119, 代码块缺少语言标记（触发 MD040）；找到文档中使用的围栏代码块标记 ``` 并在开头的 ``` 后添加合适的语言标签（例如 ```text 或匹配代码片段的语言），以便 lint 识别语言并通过校验，确保开始围栏与结束围栏仍然成对出现并与现有内容语义匹配。
185-193:⚠️ Potential issue | 🟠 Major文末仍缺少
## 引用章节该问题此前已指出，当前版本依然未补齐。
As per coding guidelines "
docs/**/*.md: Maintain a '## References' (or '## 引用') section at the end of documentation files listing all external links".🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/05-releases/pr-0.7.4.md` around lines 185 - 193, The document is missing the required trailing "## 引用" (or "## References") section; add a final heading "## 引用" to the end of the markdown and list all external links referenced in the release notes (e.g., changelog entry, build/CI docs, any third‑party resources) as bullet items with full URLs; ensure the heading name matches the guideline exactly ("## 引用") and place it after the existing checklist so the file ends with that section.
105-108:⚠️ Potential issue | 🟡 Minor表格前缺少空行（MD058）
Line [106] 的表格前建议补 1 个空行，避免 markdownlint 警告。
建议修改
- **`build`**：`pnpm update -r` 升级 minor 版本 + | 包 | 旧版本 | 新版本 | |---|---|---|🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/05-releases/pr-0.7.4.md` around lines 105 - 108, Add a single blank line before the markdown table that follows the "**`build`**：`pnpm update -r` 升级 minor 版本" paragraph in the release notes so the table is separated from the preceding paragraph (this resolves MD058); edit the section containing the table header and insert one empty line immediately above the table start to satisfy markdownlint.website/Dockerfile.dev (1)
34-36:⚠️ Potential issue | 🟠 Major
VITE_BASE_PATH可覆盖会破坏 dev 路由契约这个问题之前已提过：当前允许外部覆盖基础路径，但
nginx.dev.conf仅服务/dev，覆盖后会出现路由/资源 404。建议修改
-# VitePress 基础路径，开发环境通常为 /dev/，生产环境为 /prod/，构建时必须指定 -ARG VITE_BASE_PATH=/dev/ -ENV VITE_BASE_PATH=$VITE_BASE_PATH +# VitePress 基础路径（dev 镜像固定为 /dev/，与 nginx.dev.conf 保持一致） +ENV VITE_BASE_PATH=/dev/🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@website/Dockerfile.dev` around lines 34 - 36, The Dockerfile exposes VITE_BASE_PATH via ARG which allows external overrides and breaks the dev nginx routing (nginx.dev.conf serves only /dev); remove the ARG-driven override and ensure the ENV is fixed to /dev by eliminating ARG VITE_BASE_PATH and setting ENV VITE_BASE_PATH=/dev (or ignore ARG and hardcode ENV to '/dev') so builds cannot change the base path at build time; update the lines referencing VITE_BASE_PATH in Dockerfile.dev accordingly.docs/STANDARD.md (1)
197-202:⚠️ Potential issue | 🟠 Major规范层移除了
## 引用约束，和仓库规则冲突Line [197]-[202] 只保留了链接写法规则，但没有保留“文末必须维护
## 引用外链清单”的要求；同时本文档结尾也缺少## 引用。这会把违规扩散到下游文档。As per coding guidelines "
docs/**/*.md: Maintain a '## References' (or '## 引用') section at the end of documentation files listing all external links".🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/STANDARD.md` around lines 197 - 202, The STANDARD.md change removed the repository rule requiring a trailing "## 引用" section, which conflicts with the docs/* guideline; restore the requirement by updating the "## 6. 引用规范" section to explicitly state that every docs/**/*.md must include a "## 引用" (or "## References") header at the end listing all external links, and ensure STANDARD.md itself includes a concrete "## 引用" section at the end as an example; reference the "## 6. 引用规范" header and the "## 引用" header when making this edit.docs/03-architecture/openapi-enrichment.md (1)
286-293:⚠️ Potential issue | 🟠 Major文档末尾仍缺少
## 引用章节该问题在此前评审已提到，当前版本仍未补齐。
As per coding guidelines "
docs/**/*.md: Maintain a '## References' (or '## 引用') section at the end of documentation files listing all external links".🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/03-architecture/openapi-enrichment.md` around lines 286 - 293, 在文档末尾添加一个名为 "## 引用" 的章节并列出文中引用的所有外部链接与资料（例如 ZodValidationPipe、ZodSerializerInterceptor、Swagger/OpenAPI、WebSocket/SSE、分页设计参考等相关外部资源），每条使用完整可访问的 URL 和简短描述，确保覆盖文中提及的外部库、规范与参考文章以符合 docs/**/*.md 的引用规范。website/nginx.prod.conf (1)
40-49:⚠️ Potential issue | 🟡 Minor补上
/prod/api-reference的 301 规范化，并把 SPA location 收紧到/prod/。现在
/prod/api-reference/只覆盖带尾斜杠的请求，而location /prod会把/prod/api-reference和/production这类路径都兜进 SPA。建议补一个精确匹配重定向，并把 SPA block 改成/prod/。建议修改
+ location = /prod/api-reference { + return 301 /prod/api-reference/; + } + # API Reference — Scalar 静态页 + openapi.json，剥掉 /prod 前缀 location /prod/api-reference/ { rewrite ^/prod/(.+)$ /$1 break; root /usr/share/nginx/html; try_files $uri $uri/ $uri.html =404; } # 文档站 — VitePress SPA，alias 剥掉 /prod 前缀，路由 fallback 到 index.html - location /prod { + location /prod/ { alias /usr/share/nginx/html/; try_files $uri $uri/ $uri.html `@prod_fallback`; }可用下面的只读脚本确认当前配置仍存在这个匹配风险：
#!/bin/bash # 检查是否缺少 /prod/api-reference 的精确重定向，以及 SPA block 是否仍为宽前缀匹配 sed -n '35,55p' website/nginx.prod.conf | nl -ba rg -n 'location\s+=\s+/prod/api-reference|location\s+/prod/|location\s+/prod\b' website/nginx.prod.conf期望看到的问题信号：
- 没有
location = /prod/api-reference- SPA block 仍是
location /prod {🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@website/nginx.prod.conf` around lines 40 - 49, Add a precise 301 redirect for the exact path "/prod/api-reference" and tighten the SPA location to only the "/prod/" prefix: create a exact-match location (location = /prod/api-reference) that issues a 301 to the normalized URL, and change the current SPA block from "location /prod" to "location /prod/" (updating the alias/try_files/@prod_fallback usage accordingly) so that paths like "/prod/api-reference" or "/production" are not swallowed by the SPA fallback.docs/02-harness/overview.md (1)
1-7:⚠️ Potential issue | 🟠 Major补齐 frontmatter 必填字段。
这里目前只有
title/status/version/last-updated/category，还缺少文档规范要求的inherits和related。建议在合入前补齐，避免继承链和文档元数据消费出错。建议修改
--- title: 什么是 Harness Engineering +inherits: docs/02-harness/STANDARD.md status: active version: "0.7.4" last-updated: 2026-04-09 category: harness +related: + - docs/02-harness/STANDARD.md + - docs/02-harness/feedforward.md + - docs/02-harness/feedback.md ---As per coding guidelines, "Ensure frontmatter is complete with fields: inherits, related, status, version, last-updated".
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/02-harness/overview.md` around lines 1 - 7, The frontmatter of the document is missing required metadata fields; add the inherits and related keys to the existing YAML frontmatter (alongside title/status/version/last-updated/category) so the frontmatter block includes inherits: <value> and related: <value or list>, ensuring both keys are present and follow the same YAML formatting as the other fields to satisfy the document metadata consumer.
🧹 Nitpick comments (1)
docs/04-appendix/about.md (1)
25-25: 措辞可读性小优化：建议使用“诚挚地感谢”Line 25 的“致以诚挚的感谢”可改为“致以诚挚地感谢”或“表示诚挚感谢”，语感更自然。
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/04-appendix/about.md` at line 25, Replace the phrase "致以诚挚的感谢" in the sentence "本项目站在以下优秀开源项目的肩膀上构建，向它们的作者和社区致以诚挚的感谢。" with a more natural wording such as "致以诚挚地感谢" or "表示诚挚感谢" so the sentence reads e.g. "本项目站在以下优秀开源项目的肩膀上构建，向它们的作者和社区表示诚挚感谢。".
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/00-getting-started/quick-start.md`:
- Around line 155-163: 文末缺少“## 引用”节：在当前文档（以“## 接下来做什么？”段落结尾处）添加一个名为“## 引用”（或“##
References”）的章节，列出文中出现的所有外部链接并为每个链接提供简短标题和完整
URL（例如指向开发工作流、环境搭建、测试指南、项目架构全览和核心理念的外部/相对链接），确保引用格式统一并放在文档末尾以满足 docs/**/*.md
的引用规范。
- Around line 1-7: The frontmatter in quick-start.md is missing the required
inherits and related fields; update the YAML frontmatter block at the top of the
file to include inherits and related alongside the existing status, version, and
last-updated keys (e.g., add an inherits: <value> and related: <list or value>
entries appropriate for this guide) so the document satisfies the docs/**/*.md
contract and preserves inheritance/relationship metadata.
- Around line 41-43: Update the git clone URL in the quick-start snippet:
replace the exact line "git clone
https://github.com/gdmuna/nestjs-demo-basic.git my-project" with this
repository's current GitHub URL (i.e., change "gdmuna/nestjs-demo-basic" to the
repository's new name so the clone command points to the correct repo).
In `@docs/02-harness/overview.md`:
- Around line 32-38: Add a language tag to the fenced code block in
docs/02-harness/overview.md (the block that starts with "你的 AI 编程工具" and shows
the Harness diagram) by marking it as "text" so markdownlint MD040 is not
triggered; update the opening fence from ``` to ```text and leave the contents
unchanged.
In `@docs/03-architecture/openapi-enrichment.md`:
- Line 190: 将文档中第190行的错别字与术语间距修正：把“示例値从ErrorRegistry”替换为“示例值从
ErrorRegistry”，即将“値”改为“值”并在“ErrorRegistry”前后加入空格以消除阅读噪声，确保文中对 ErrorRegistry
的引用格式统一。
In `@docs/04-appendix/about.md`:
- Line 21: Replace the outdated repository path "gdmuna/nestjs-demo-basic" with
the new "gdmuna/nestjs-scaffold" in this document; search for the markdown link
text/URL occurrences (e.g. the GitHub Issues link and any other instances of the
string "gdmuna/nestjs-demo-basic" present around the lines referenced) and
update them so both the link target and visible text (if present) reflect
"gdmuna/nestjs-scaffold".
- Around line 1-7: The frontmatter block is missing the required fields
`inherits` and `related`; update the frontmatter at the top of the document (the
YAML block containing title/status/version/last-updated) to include `inherits`
and `related` keys (use an appropriate value or an empty list `[]` if there are
no entries) so the document conforms to the docs/**/*.md guideline requiring
`inherits, related, status, version, last-updated`; ensure the keys are valid
YAML keys and preserve the existing fields (`title`, `status`, `version`,
`last-updated`, `category`) and formatting.
- Around line 90-95: Add a final "## References" (or "## 引用") section to
docs/04-appendix/about.md that enumerates all external links used in the file
(e.g., the MIT license URL
https://github.com/gdmuna/nestjs-demo-basic/blob/main/LICENSE and any other
external references), listing each link as a bullet with a short label; ensure
the new "## References"/"## 引用" header appears after the existing "## 声明"
content and includes every external URL referenced in the document for
compliance with docs/**/*.md guidelines.
---
Outside diff comments:
In `@website/.vitepress/config.ts`:
- Around line 151-161: Update all hard-coded references to the old repository
name "gdmuna/nestjs-demo-basic" to the new/current repository name in the
Vitepress config: replace the URL in socialLinks[0].link, the LICENSE link
inside footer.message, the href in footer.copyright anchor, and the
editLink.pattern so documentation edit links point to the correct repo; ensure
the new repo name is used consistently in those three places (socialLinks,
footer.message/footer.copyright, editLink).
---
Duplicate comments:
In `@docs/02-harness/overview.md`:
- Around line 1-7: The frontmatter of the document is missing required metadata
fields; add the inherits and related keys to the existing YAML frontmatter
(alongside title/status/version/last-updated/category) so the frontmatter block
includes inherits: <value> and related: <value or list>, ensuring both keys are
present and follow the same YAML formatting as the other fields to satisfy the
document metadata consumer.
In `@docs/03-architecture/openapi-enrichment.md`:
- Around line 286-293: 在文档末尾添加一个名为 "## 引用" 的章节并列出文中引用的所有外部链接与资料（例如
ZodValidationPipe、ZodSerializerInterceptor、Swagger/OpenAPI、WebSocket/SSE、分页设计参考等相关外部资源），每条使用完整可访问的
URL 和简短描述，确保覆盖文中提及的外部库、规范与参考文章以符合 docs/**/*.md 的引用规范。
In `@docs/05-releases/pr-0.7.4.md`:
- Around line 1-7: The frontmatter in the release doc (the YAML block with
title/version/base/branch/date) is missing required fields; update the
frontmatter for this file to include the required keys inherits, related,
status, and last-updated (in addition to the existing title, version, base,
branch, date) and populate them with appropriate values per the docs guideline;
ensure the frontmatter remains valid YAML and follows the project's docs
template for release pages so automated checks pass.
- Line 119: 代码块缺少语言标记（触发 MD040）；找到文档中使用的围栏代码块标记 ``` 并在开头的 ``` 后添加合适的语言标签（例如
```text 或匹配代码片段的语言），以便 lint 识别语言并通过校验，确保开始围栏与结束围栏仍然成对出现并与现有内容语义匹配。
- Around line 185-193: The document is missing the required trailing "## 引用" (or
"## References") section; add a final heading "## 引用" to the end of the markdown
and list all external links referenced in the release notes (e.g., changelog
entry, build/CI docs, any third‑party resources) as bullet items with full URLs;
ensure the heading name matches the guideline exactly ("## 引用") and place it
after the existing checklist so the file ends with that section.
- Around line 105-108: Add a single blank line before the markdown table that
follows the "**`build`**：`pnpm update -r` 升级 minor 版本" paragraph in the release
notes so the table is separated from the preceding paragraph (this resolves
MD058); edit the section containing the table header and insert one empty line
immediately above the table start to satisfy markdownlint.
In `@docs/STANDARD.md`:
- Around line 197-202: The STANDARD.md change removed the repository rule
requiring a trailing "## 引用" section, which conflicts with the docs/* guideline;
restore the requirement by updating the "## 6. 引用规范" section to explicitly state
that every docs/**/*.md must include a "## 引用" (or "## References") header at
the end listing all external links, and ensure STANDARD.md itself includes a
concrete "## 引用" section at the end as an example; reference the "## 6. 引用规范"
header and the "## 引用" header when making this edit.
In `@website/Dockerfile.dev`:
- Around line 34-36: The Dockerfile exposes VITE_BASE_PATH via ARG which allows
external overrides and breaks the dev nginx routing (nginx.dev.conf serves only
/dev); remove the ARG-driven override and ensure the ENV is fixed to /dev by
eliminating ARG VITE_BASE_PATH and setting ENV VITE_BASE_PATH=/dev (or ignore
ARG and hardcode ENV to '/dev') so builds cannot change the base path at build
time; update the lines referencing VITE_BASE_PATH in Dockerfile.dev accordingly.
In `@website/nginx.prod.conf`:
- Around line 40-49: Add a precise 301 redirect for the exact path
"/prod/api-reference" and tighten the SPA location to only the "/prod/" prefix:
create a exact-match location (location = /prod/api-reference) that issues a 301
to the normalized URL, and change the current SPA block from "location /prod" to
"location /prod/" (updating the alias/try_files/@prod_fallback usage
accordingly) so that paths like "/prod/api-reference" or "/production" are not
swallowed by the SPA fallback.
---
Nitpick comments:
In `@docs/04-appendix/about.md`:
- Line 25: Replace the phrase "致以诚挚的感谢" in the sentence
"本项目站在以下优秀开源项目的肩膀上构建，向它们的作者和社区致以诚挚的感谢。" with a more natural wording such as
"致以诚挚地感谢" or "表示诚挚感谢" so the sentence reads e.g.
"本项目站在以下优秀开源项目的肩膀上构建，向它们的作者和社区表示诚挚感谢。".
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 2e28c37f-d76a-4f47-bdd2-6023635a87b6
⛔ Files ignored due to path filters (2)
docs/public/img/gdmuna-logo_gradient-cut.pngis excluded by!**/*.pngdocs/public/img/gdmuna-logo_gradient.svgis excluded by!**/*.svg
📒 Files selected for processing (25)
AGENTS.mdCHANGELOG.mdREADME.mddocs/00-getting-started/introduction.mddocs/00-getting-started/philosophy.mddocs/00-getting-started/quick-start.mddocs/02-harness/overview.mddocs/03-architecture/exception-system.mddocs/03-architecture/openapi-enrichment.mddocs/03-architecture/route-decorator.mddocs/04-appendix/CHANGELOG.mddocs/04-appendix/STANDARD.mddocs/04-appendix/about.mddocs/04-appendix/error-reference.mddocs/04-appendix/external-resources.mddocs/05-releases/pr-0.7.4.mddocs/README.mddocs/STANDARD.mdscripts/generate-error-reference.tssrc/constants/observability.constant.tswebsite/.vitepress/config.tswebsite/Dockerfile.devwebsite/Dockerfile.prodwebsite/nginx.dev.confwebsite/nginx.prod.conf
✅ Files skipped from review due to trivial changes (9)
- docs/04-appendix/STANDARD.md
- docs/04-appendix/CHANGELOG.md
- scripts/generate-error-reference.ts
- docs/00-getting-started/philosophy.md
- docs/04-appendix/external-resources.md
- docs/00-getting-started/introduction.md
- AGENTS.md
- CHANGELOG.md
- docs/README.md
🚧 Files skipped from review as they are similar to previous changes (4)
- src/constants/observability.constant.ts
- website/Dockerfile.prod
- docs/03-architecture/route-decorator.md
- docs/03-architecture/exception-system.md
Clearly communicate that no official Minor release has been published yet: - README.md: add blockquote warning with context on 0.x instability and guidance to pin to a specific commit/tag rather than tracking main - introduction.md: add :::warning callout block with same message expanded — explains interface contract, directory structure, and config volatility before v1.0.0, and promises a migration guide upon stable release - CHANGELOG.md / pr-0.7.4.md: record new entry in 文档重构 section
'1.0.0' is the first Major version bump (0→1), not a Minor release. Update all four affected files to use '首个稳定大版本' and '首个 Major 版本升级'.
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
docs/00-getting-started/introduction.md (1)
131-153: 为代码块指定语言标识符目录结构展示的代码块未指定语言，建议标注为
text以消除 markdownlint 警告。🔧 建议修改
-``` +```text nestjs-scaffold/ ├── .github/workflows/ # 10 个 GitHub Actions 工作流 ├── .agents/skills/ # AI 助手技能文档🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/00-getting-started/introduction.md` around lines 131 - 153, The fenced code block that renders the directory tree is missing a language tag (it's currently just triple backticks); update that fenced block (the directory-tree code block showing "nestjs-scaffold/ ├── ...") to use a language identifier by replacing the opening ``` with ```text so markdownlint warnings are resolved and the block is explicitly marked as plain text.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/00-getting-started/introduction.md`:
- Line 160: Add a trailing "## 引用" (References) section to the end of this
docs/00-getting-started/introduction.md file that consolidates all external
links referenced in the document; ensure the heading is exactly "## 引用" and
include each external URL with a short descriptive label (e.g., link text and
URL) so the file complies with the docs/**/*.md guideline requiring a References
section.
- Around line 1-7: The frontmatter in the document with title "项目简介" is missing
required metadata; add the `inherits` and `related` fields (alongside existing
`status`, `version`, `last-updated`) to the YAML frontmatter so it conforms to
docs/**/*.md requirements; update the frontmatter block at the top of the file
(the YAML section containing title/status/version/last-updated) and populate
`inherits` (e.g., an array or null) and `related` (e.g., an array of related doc
slugs) with appropriate values following the project's frontmatter conventions.
---
Nitpick comments:
In `@docs/00-getting-started/introduction.md`:
- Around line 131-153: The fenced code block that renders the directory tree is
missing a language tag (it's currently just triple backticks); update that
fenced block (the directory-tree code block showing "nestjs-scaffold/ ├── ...")
to use a language identifier by replacing the opening ``` with ```text so
markdownlint warnings are resolved and the block is explicitly marked as plain
text.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 346aca46-154f-41a3-9a98-b5097e15ae50
📒 Files selected for processing (4)
CHANGELOG.mdREADME.mddocs/00-getting-started/introduction.mddocs/05-releases/pr-0.7.4.md
🚧 Files skipped from review as they are similar to previous changes (1)
- CHANGELOG.md
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
1 participant
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.
发布 v0.7.4
概述
本 PR 将
release/0.7分支合并至main，发布 v0.7.4 版本。主要内容：项目正式更名为 NestJS Scaffold；文档站全面重构（目录重整、新增入门文档区与 Harness Engineering 文档区）；文档站路由重写为语义化 URL（/guide/ / /reference/）、侧边栏双分区重构；新增关于本项目页；hero 图片及首页更新；后端容器改为非 root 用户运行；依赖 minor 版本升级；修复 Docker 构建 CHANGELOG 缺失及 API reference 路径问题。变更内容
✨ 新功能 / 改进
项目重命名
chore）— 项目正式更名package.jsonname:nestjs-demo-basic→nestjs-scaffold，version:0.7.3→0.7.4docker-compose.yml: compose project name 及APP_NAME默认值由nestjs-demo-basic改为nestjs-scaffoldsrc/main.ts: Swagger 标题Nestjs-Demo-Basic API→NestJS Scaffold API；figlet 启动 Banner 同步更新文档站全面重构
docs）— 原有目录整体上移一级，腾出前置位编号给新增的入门文档区：docs/02-architecture/→docs/03-architecture/docs/03-reference/→docs/04-reference/docs/04-planning/→docs/05-releases/（目录职责同步调整为"发布文档"）docs/05-audits/→docs/06-audits/docs/00-getting-started/（docs）— 入门文档区introduction.md：项目简介、核心理念、分层架构 Mermaid、技术栈、目录结构philosophy.md：核心设计理念深度解析quick-start.md：5 分钟快速启动指南docs/02-harness/（docs）— Harness Engineering 专项文档区overview.md：Harness Engineering 整体框架feedback.md：反馈回路（测试 / CI / lint）feedforward.md：前馈引导（AGENTS.md / 文档 / 架构规范）STANDARD.md：本区文档写作规范docs）—docs/index.md（VitePress 首页）、docs/changelog.md（文档内变更日志页）、docs/public/img/logo-small.svgdocs/01-guides/指南文档（docs）：development-workflow.md：本地开发工作流docker-deployment.md：容器化部署指南environment-setup.md：环境搭建详细步骤testing.md：测试策略与运行说明contributing.md：重写贡献指南docs）—docs/03-architecture/三份文档去除"规划期"写法：exception-system.md：§1 由"设计动机"改为"设计背景"，AppException接口定义对齐实现，ErrorRegistry 路径更新route-decorator.md：§1 时态更正，§9"向后兼容"改为"迁移历史"openapi-enrichment.md：§2 流水线描述对齐实际实现（wrapSuccessResponses、enrichErrorResponses、enrichTagDescriptions），§9 配置代码块更新为实际main.ts内容，ERROR_CATALOG 引用改为 ErrorRegistrydocs）— 中文"驾驭工程"全部替换为英文"Harness Engineering"（含文档正文、frontmatter title、VitePress 导航/侧边栏）docs）— 新增功能特性矩阵、Harness Engineering 介绍、项目目录结构速览、快速启动命令容器安全
feat(dockerfile)）Dockerfilerunner 阶段新增RUN chown -R node:node /app和USER nodenode:22-slim内置的node用户（uid=1000），无需额外安装VitePress 站点升级
chore(website)）—website/package.json新增@mdit/plugin-tasklist，website/.vitepress/config.ts集成插件chore(website)）— 新增 Harness Engineering（02-harness）、Getting Started（00-getting-started）等新节；移除已废弃的02-architecture配置chore(website)）—驾驭工程→Harness Engineering，什么是驾驭工程→什么是 Harness Engineeringchore(website)）—NestJS Demo Basic→NestJS Scaffold文档站路由与导航重构（后续增补）
docs(vitepress)）— 新增rewrites配置，将编号目录路径映射为可读 URL，文件路径不变：/guide/*：涵盖00-getting-started/、01-guides/、04-reference/附录类内容/reference/*：涵盖02-harness/、03-architecture/深度文档docs(vitepress)）— 上手（/guide/）/ 深入（/reference/）两个独立侧边栏，nav 条目重命名并添加activeMatch，解决落地页 404 与高亮缺失问题docs(vitepress)）—srcExclude排除STANDARD.md/AGENTS.md，修复 rewrites 后同名文件映射重复路由导致 MiniSearch 抛错assets(docs)）— 新增三种规格 logo 图片（PNG / WebP）；style.css添加响应式尺寸断点；首页 hero 更新图片源、精简文案、重组 actions 按钮docs）— 新增about.md，合并 Maintainers 与致谢内容（路由/guide/about）docs）—docs/changelog.md→docs/04-reference/CHANGELOG.md，通过@include导入根目录CHANGELOG.md🐛 修复（后续增补）
fix(docker)：Dockerfile.dev / prod 构建阶段补加COPY CHANGELOG.md ./，修复生产镜像中@include内容为空的问题；API reference 路径统一更新（/reference/api/→/api-reference/）fix(docs)：修复external-resources.md重复节标题docs(readme)：补全文档站访问链接；精简 README，移除与文档站重复的章节📁 文档重构（后续增补）
refactor(docs)：docs/04-reference/重命名为docs/04-appendix/，与实际定位（附录）一致；同步更新 VitePress rewrites 规则、脚本输出路径、常量默认值及所有文档内引用docs(harness)：docs/02-harness/overview.md末尾新增局限性说明块，诚实披露当前实现与文档描述之间的差距docs：README.md与docs/00-getting-started/introduction.md新增“尚未发布首个稳定大版本”说明块，明确告知项目尚未发布1.0.0（首个 Major 版本升级），接口契约在此之前不稳定，建议锁定到特定 commit 或 tag🛠️ 杂项 / 工程化
chore：AGENTS.md升至 v0.7.4docs/02-architecture/→docs/03-architecture/）docs/STANDARD.md）、删除防御性编程章节（边界已由 Zod 统一处理，不需要单独原则提醒）pnpm format前置步骤；§5.3 检查清单同步.github/copilot-instructions.md架构文档路径同步更新fix(scripts)：scripts/generate-error-reference.ts输出路径03-reference→04-referencefix：src/constants/observability.constant.tsERROR_REFERENCE_URL默认值路径同步更新📦 依赖升级
build：pnpm update -r升级 minor 版本@dotenvx/dotenvx-ops^0.37.4^0.37.8@nestjs/config^4.0.3^4.0.4@nestjs/swagger^11.2.6^11.2.7@prisma/adapter-pg^7.6.0^7.7.0@prisma/client^7.6.0^7.7.0prisma^7.6.0^7.7.0@nestjs/cli^11.0.17^11.0.19@typescript-eslint/*^8.58.0^8.58.1文件变更统计
测试验证
pnpm format— ✅ 通过pnpm lint— ✅ 通过pnpm build— ✅ 通过（tsc + tsc-alias，42 files）pnpm test— ✅ 通过（7 suites, 21 tests, 0 failures）pnpm build（VitePress）— ✅ 通过（8.6s）检查清单
pnpm format— 格式化通过pnpm lint— 零错误pnpm build— 编译通过pnpm test— 通过CHANGELOG.md新增 v0.7.4 条目）