Commit 43397c8
authored
⚙️ [Maintenance]: Fix Docs Lint pipeline (MD060 tables + codespell false positives) (#52)
The Docs pipeline's `Lint` job (super-linter) is green again. It had
been failing on `main` since the Continuous-X / DevOps guides were
added, and every pull request inherited the failure because super-linter
validates the entire codebase.
## Fixed: Docs Lint pipeline passes again
Two independent problems in the guide files added by 99d9d5a were
blocking the job:
- **MD060 / table-column-style (36 errors)** in
`continuous-x-and-continuous-ai.md` and `devops-reference.md`. The
tables mixed padded header/body cells (`| # |`) with compact delimiter
rows (`|---|`). Fixed by padding the delimiter rows so each table uses
one consistent style — the rendered tables are unchanged.
- **codespell false positives** surfaced once MD060 was resolved. Both
are legitimate text, not typos, so they are added to the codespell
`ignore-words-list` rather than "corrected":
- `Skelton` — the surname of **Matthew Skelton**, co-author of *Team
Topologies*.
- `erformance` — an artifact of the SPACE-framework acronym
`**P**erformance` (**S**atisfaction, **P**erformance, **A**ctivity,
**C**ommunication, **E**fficiency).
## Technical Details
- `src/docs/Ways-of-Working/continuous-x-and-continuous-ai.md`,
`src/docs/Ways-of-Working/devops-reference.md`: delimiter rows padded
(rows 10, 23, 76, 85 and 12, 60). Verified with markdownlint-cli2
(markdownlint v0.41.0) against `.github/linters/.markdown-lint.yml` — 0
errors.
- `.github/linters/.codespellrc`: `ignore-words-list` extended with
`skelton,erformance` (alongside the existing `afterall`). Verified with
codespell — 0 errors.
- Full super-linter run is green (MARKDOWN, SPELL_CODESPELL, and all
other linters) and Build passes.
This follows Option A from the issue (reformat the tables), plus the
codespell false-positive handling needed to actually turn the `Lint` job
green.
<details>
<summary>Related issues</summary>
- Fixes #51
</details>1 parent 99d9d5a commit 43397c8
3 files changed
Lines changed: 7 additions & 7 deletions
File tree
- .github/linters
- src/docs/Ways-of-Working
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
Lines changed: 4 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
10 | | - | |
| 10 | + | |
11 | 11 | | |
12 | 12 | | |
13 | 13 | | |
| |||
20 | 20 | | |
21 | 21 | | |
22 | 22 | | |
23 | | - | |
| 23 | + | |
24 | 24 | | |
25 | 25 | | |
26 | 26 | | |
| |||
73 | 73 | | |
74 | 74 | | |
75 | 75 | | |
76 | | - | |
| 76 | + | |
77 | 77 | | |
78 | 78 | | |
79 | 79 | | |
| |||
82 | 82 | | |
83 | 83 | | |
84 | 84 | | |
85 | | - | |
| 85 | + | |
86 | 86 | | |
87 | 87 | | |
88 | 88 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | | - | |
| 12 | + | |
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
| |||
57 | 57 | | |
58 | 58 | | |
59 | 59 | | |
60 | | - | |
| 60 | + | |
61 | 61 | | |
62 | 62 | | |
63 | 63 | | |
| |||
0 commit comments