docs: 清除 markdown lint 警告(MD040 補語言標註、MD060 關閉)
- 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 <noreply@anthropic.com>
This commit is contained in:
7
.markdownlint.jsonc
Normal file
7
.markdownlint.jsonc
Normal file
@@ -0,0 +1,7 @@
|
||||
{
|
||||
// 本專案文件以繁體中文為主,表格一律按「終端顯示寬度」對齊(CJK 字元佔 2 欄),
|
||||
// 這是人類在編輯器裡讀得順的排法。MD060 以「字元位置」比對管線符號,對 CJK
|
||||
// 無感——兩者不可能同時滿足。選擇保留顯示寬度對齊,關閉此規則。
|
||||
// 其餘規則維持預設(含 MD040:程式碼區塊必須標語言)。
|
||||
"MD060": false
|
||||
}
|
||||
10
AGENTS.md
10
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
|
||||
<repo 相對路徑>#<sha256 前 8 碼>
|
||||
```
|
||||
|
||||
@@ -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] <op> | <title>
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user