Commit 83fb669
committed
feat(ci): add Markdown and Mermaid linting
Introduce `markdown:lint` which chains structural markdown checks
(markdownlint-cli2) and Mermaid diagram validation. Both run as part of
`mise run lint` and as a dedicated GitHub Actions job.
Mermaid diagrams are validated by calling `mermaid.parse()` via a small
Node script with a jsdom shim — no Chromium/Puppeteer required. This
catches real parse errors (e.g. the `exec()s` sequence-diagram bug in
`architecture/sandbox-connect.md`) that browser-free alternatives like
`maid` silently miss.
Tooling:
- `.markdownlint-cli2.jsonc` with `gitignore: true`, sensible rule
overrides (MD033 allowlist for GitHub-rendered HTML, MD060 padded
table style, MD013/MD034 off to match project style).
- `docs/.markdownlint-cli2.jsonc` overrides for MDX (no top-level H1,
JSX components may look like HTML).
- `scripts/lint-mermaid/` hosts the validator with a committed
`package-lock.json` for reproducible CI installs (`npm ci`).
- `markdownlint-cli2` pinned via mise `npm:` backend.
Existing doc fixes applied to satisfy the new checks: adds `text`
language to bare code fences (via one-shot codemod), corrects list
indentation at the single-digit → double-digit boundary in
`architecture/sandbox.md`, plus minor blank-line and trailing-newline
fixes.1 parent 4483c86 commit 83fb669
47 files changed
Lines changed: 2398 additions & 77 deletions
File tree
- .github/workflows
- architecture
- crates
- openshell-cli/src
- openshell-driver-vm
- openshell-vm
- runtime
- docs
- get-started/tutorials
- inference
- reference
- sandboxes
- examples
- local-inference
- policy-advisor
- private-ip-routing
- sandbox-policy-quickstart
- rfc
- scripts/lint-mermaid
- tasks
Some content is hidden
Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
100 | 100 | | |
101 | 101 | | |
102 | 102 | | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
202 | 202 | | |
203 | 203 | | |
204 | 204 | | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
258 | 258 | | |
259 | 259 | | |
260 | 260 | | |
261 | | - | |
| 261 | + | |
262 | 262 | | |
263 | 263 | | |
264 | 264 | | |
| |||
279 | 279 | | |
280 | 280 | | |
281 | 281 | | |
282 | | - | |
| 282 | + | |
283 | 283 | | |
284 | 284 | | |
285 | 285 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | | - | |
| 13 | + | |
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
142 | 142 | | |
143 | 143 | | |
144 | 144 | | |
| 145 | + | |
145 | 146 | | |
146 | 147 | | |
147 | 148 | | |
| |||
198 | 199 | | |
199 | 200 | | |
200 | 201 | | |
201 | | - | |
202 | 202 | | |
203 | 203 | | |
204 | 204 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
61 | 61 | | |
62 | 62 | | |
63 | 63 | | |
64 | | - | |
| 64 | + | |
65 | 65 | | |
66 | 66 | | |
67 | 67 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
99 | 99 | | |
100 | 100 | | |
101 | 101 | | |
102 | | - | |
| 102 | + | |
103 | 103 | | |
104 | 104 | | |
105 | 105 | | |
| |||
0 commit comments