From b2eb4fbfa384cba12b6be1214ed8e67500af7cde Mon Sep 17 00:00:00 2001 From: LittleYellow Date: Wed, 22 Jul 2026 07:35:44 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=B8=85=E9=99=A4=20markdown=20lint=20?= =?UTF-8?q?=E8=AD=A6=E5=91=8A=EF=BC=88MD040=20=E8=A3=9C=E8=AA=9E=E8=A8=80?= =?UTF-8?q?=E6=A8=99=E8=A8=BB=E3=80=81MD060=20=E9=97=9C=E9=96=89=EF=BC=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - MD040：AGENTS.md 四處與 README.md 一處的 fenced code block 補上語言標註 （目錄樹與格式範例用 text，index.md / log.md 的範例用 markdown）。 - MD060：本專案文件表格一律按終端顯示寬度對齊（CJK 佔 2 欄），而 MD060 以 字元位置比對管線符號，對 CJK 無感，兩者不可能同時滿足。選擇保留顯示寬度 對齊（人類在編輯器裡讀得順），以 .markdownlint.jsonc 關閉該規則並註明理由。 順帶修正 AGENTS.md §3.1 表格 entity 列的對齊——該列混入 ASCII 的 API， 原本比其他列短 1 欄。 未處理 MD013（行長 > 80）：VS Code 的 markdownlint 擴充預設不啟用此規則， 且 §3.1 表格在維持顯示對齊的前提下無法壓到 80 字元以內。 Co-Authored-By: Claude Opus 4.8 --- .markdownlint.jsonc | 7 +++++++ AGENTS.md | 10 +++++----- README.md | 2 +- 3 files changed, 13 insertions(+), 6 deletions(-) create mode 100644 .markdownlint.jsonc diff --git a/.markdownlint.jsonc b/.markdownlint.jsonc new file mode 100644 index 0000000..a342a21 --- /dev/null +++ b/.markdownlint.jsonc @@ -0,0 +1,7 @@ +{ + // 本專案文件以繁體中文為主，表格一律按「終端顯示寬度」對齊（CJK 字元佔 2 欄）， + // 這是人類在編輯器裡讀得順的排法。MD060 以「字元位置」比對管線符號，對 CJK + // 無感——兩者不可能同時滿足。選擇保留顯示寬度對齊，關閉此規則。 + // 其餘規則維持預設（含 MD040：程式碼區塊必須標語言）。 + "MD060": false +} diff --git a/AGENTS.md b/AGENTS.md index 5aee872..58db05d 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -39,7 +39,7 @@ ## 2. 目錄結構 -``` +```text pp-qa-knowledge/ ├── AGENTS.md # 本檔：schema 正本 ├── CLAUDE.md # 指標檔 → AGENTS.md @@ -70,7 +70,7 @@ pp-qa-knowledge/ | type | 位置 | 用途 | 一份來源對應 | |-----------|-------------------|--------------------------------------------|--------------| | `summary` | `wiki/summaries/` | 每份來源文件一頁摘要 | 1:1 | -| `entity` | `wiki/entities/` | 系統、模組、API、法規條目、專案等具名實體 | n:m | +| `entity` | `wiki/entities/` | 系統、模組、API、法規條目、專案等具名實體 | n:m | | `concept` | `wiki/concepts/` | 跨來源綜合：缺陷模式、測試策略、法遵準則 | n:m | ### 3.2 YAML frontmatter（所有欄位必填，lint 檢查） @@ -93,7 +93,7 @@ status: draft # draft（攝入產出）| reviewed（人工審 ### 3.3 source_ref 格式 -``` +```text # ``` @@ -193,13 +193,13 @@ wiki 頁檔名用英文 kebab-case slug（如 `wiki/entities/payment-gateway.md` **index.md** — 目錄式導航，依頁面類型分節，每頁一行： -``` +```markdown - [標題](wiki/entities/payment-gateway.md) — 一句摘要 ｜ #payment #gateway ``` **log.md** — append-only 操作日誌，新條目追加於檔案末尾，不修改既有條目： -``` +```markdown ## [YYYY-MM-DD] | ``` diff --git a/README.md b/README.md index ae2dda8..5fb51f3 100644 --- a/README.md +++ b/README.md @@ -170,7 +170,7 @@ ollama list # 對照 tasks.ingest.model / tasks.lint.model / tasks.fallba ## 6. 目錄速查 -``` +```text config/models.yaml # Ollama 端點與模型 tag（唯一設定來源） raw/originals/ # 原始檔，只讀 raw/converted/ # 轉換後 Markdown，攝入的實際輸入，只讀