Skip to content

Commit 2eb3c42

Browse files
Hooman Mehrclaude
andcommitted
Add markdown linting with rumdl across all documentation
Add .rumdl.toml config and lint-md CI job using rvben/rumdl-action. Auto-fix 199 markdown issues across 62 .md files: blank lines around lists/headings/fences, multiple blank lines, trailing whitespace. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 1d07a9a commit 2eb3c42

14 files changed

Lines changed: 305 additions & 139 deletions

.github/workflows/validate.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,14 @@ name: Validate Data
33
on: [push, pull_request]
44

55
jobs:
6+
lint-md:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v4
10+
- uses: rvben/rumdl-action@v0
11+
with:
12+
report-type: annotations
13+
614
validate:
715
runs-on: ubuntu-latest
816
steps:

.rumdl.toml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
exclude = [".venv", "node_modules", "_build"]
2+
disable = [
3+
"MD013", # line-length — docs use natural line breaks, not hard-wrapped at 80
4+
"MD024", # duplicate-heading — repeated section headers across briefs
5+
"MD025", # single-title — some output files have multiple H1s
6+
"MD034", # no-bare-urls — bare URLs in references
7+
"MD036", # no-emphasis-as-heading — bold text as pseudo-headings in briefs
8+
"MD041", # first-line-heading — some files don't start with H1
9+
"MD042", # no-empty-links — status badges use empty link targets
10+
"MD057", # table-pipe — some brief tables have formatting variations
11+
]
12+
13+
[MD004]
14+
style = "dash"
15+
16+
[MD029]
17+
style = "ordered"

CLAUDE_SESSION_LOG.md

Lines changed: 94 additions & 8 deletions
Large diffs are not rendered by default.

GOVERNANCE.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
**Iran Transition Project**
44
**Effective:** 2026
5-
**Contact:** admin@irantransitionproject.org
5+
**Contact:** <admin@irantransitionproject.org>
66

77
---
88

@@ -23,7 +23,7 @@ constitutes grounds for leadership review.
2323

2424
| Role | Holder | Scope |
2525
|------|--------|-------|
26-
| Founder / Copyright Holder | Hooman (hooman@mac.com) | Full authority while active |
26+
| Founder / Copyright Holder | Hooman (<hooman@mac.com>) | Full authority while active |
2727
| GitHub Org Owner | IranTransitionProject org | Administrative control |
2828
| Co-owner (succession backup) | To be designated | Prevents single-point-of-failure |
2929

@@ -58,6 +58,7 @@ If the Founder is unable to act and the project has been inactive for 90+ days:
5858
### Succession Criteria
5959

6060
A successor must:
61+
6162
- Accept the mission constraint without reservation
6263
- Commit to maintaining factional neutrality
6364
- Maintain the CC BY-SA 4.0 public license (alternative licensing rights
@@ -73,6 +74,7 @@ See `LICENSE` for terms.
7374
**Alternative licensing:** The copyright holder may grant alternative licensing
7475
arrangements to specific parties (e.g., policy institutions with copyleft
7576
restrictions). Such arrangements:
77+
7678
- Are granted in writing by the copyright holder only
7779
- Do not affect the CC BY-SA 4.0 terms available to all other parties
7880
- Require a signed Contributor License Agreement (CLA) from any contributor
@@ -101,6 +103,7 @@ copyright ownership — contributors retain copyright over their own work.
101103
This document may be amended by the current copyright holder or designated
102104
steward via a documented commit to the main branch. All amendments are logged
103105
in git history. No amendment may:
106+
104107
- Remove the mission constraint
105108
- Eliminate the CC BY-SA 4.0 public license
106109
- Retroactively alter contributor rights under a previously signed CLA

docs/ARCHITECTURE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Sessions that previously produced patch instructions now produce YAML edits.
2626

2727
## Pipeline Overview
2828

29-
```
29+
```text
3030
data/*.yaml (structured entity data)
3131
data/content/*.yaml (ITB/ISA module prose)
3232
data/briefs/*.yaml (convergence brief content)
@@ -47,7 +47,7 @@ via GitHub Releases as attached PDF assets.
4747

4848
## Data Directory Structure
4949

50-
```
50+
```text
5151
data/
5252
├── variables.yaml # 86 analytical variables (SV, FV, TV, PO, NQ types)
5353
├── gaps.yaml # 57 research gaps by priority and status
@@ -276,7 +276,7 @@ at session start (with project knowledge auto-sync as fallback).
276276

277277
### Coordination Protocol
278278

279-
```
279+
```text
280280
Chat (analytical session)
281281
282282
├─── writes large content to staging/session_N/

0 commit comments

Comments
 (0)