Skip to content

Commit 9839546

Browse files
chore: tighten markdownlint, fix lint issues
Switch to .markdownlint.jsonc. Local exceptions documented inline for generated/reference docs.
1 parent 613114e commit 9839546

10 files changed

Lines changed: 30 additions & 32 deletions

.markdownlint.json

Lines changed: 0 additions & 17 deletions
This file was deleted.

.markdownlint.jsonc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"default": true,
3+
"MD013": false,
4+
"MD024": { "siblings_only": true }, // CHANGELOG and API reference repeat section headings across separate release/API blocks.
5+
"MD032": false, // docs/graph-visualization.md uses compact mixed ordered/unordered list blocks pending structural rewrite.
6+
"MD033": false, // docs/schema-yaml.md includes inline HTML (<br>) in generated/reference table content.
7+
"MD040": false, // multiple architecture/reference docs still contain unlabeled fenced blocks from generated or legacy prose.
8+
"MD058": false, // schema-json/schema-yaml reference docs contain many generated tables without surrounding blank lines.
9+
"MD060": false // schema and reference docs retain mixed/compact table pipe styles from generated content.
10+
}

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Thanks for contributing.
44

55
FluxGraph is part of the Anolis ecosystem. For shared organization-level engineering and governance context, see:
6-
https://github.com/anolishq/
6+
<https://github.com/anolishq/>
77

88
## Local Development
99

docs/ARCHITECTURE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ Example: Emergency stop based on filtered temperature, not raw sensor.
137137

138138
### Stage 5: Post-Tick Write
139139

140-
_(Implicit - all writes already committed to store)_
140+
#### Implicit: all writes already committed to store
141141

142142
**Purpose:** Store now contains new state for next tick
143143

docs/EMBEDDING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ SOURCES = src/main.cpp \
156156
fluxgraph/src/thermal_mass.cpp
157157

158158
your_app: $(SOURCES)
159-
$(CXX) $(CXXFLAGS) -o your_app $(SOURCES)
159+
$(CXX) $(CXXFLAGS) -o your_app $(SOURCES)
160160
```
161161

162162
---
@@ -827,7 +827,7 @@ cmake --build . --config Release
827827

828828
## Support
829829

830-
**Issues:** https://github.com/your-org/fluxgraph/issues
830+
**Issues:** <https://github.com/your-org/fluxgraph/issues>
831831

832832
**Questions:** Post issue with "question" label
833833

docs/TRANSFORMS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ edge.transform.params["tau_s"] = 2.0; // 2-second time constant
125125

126126
**Frequency Response:**
127127

128-
- 3dB cutoff frequency: f*c = 1 / (2 * pi \_ tau)
128+
- 3dB cutoff frequency: `f_c = 1 / (2*pi*tau)`
129129
- For tau=1.0: f_c ~= 0.16 Hz
130130

131131
**Analytical Validation:**

docs/api-reference.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -686,26 +686,26 @@ engine.tick(dt, store); // Throws if no program loaded
686686
store.reserve(1000); // If you know signal count
687687
```
688688

689-
2. **Reuse SignalIds:**
689+
1. **Reuse SignalIds:**
690690

691691
```cpp
692692
// Cache IDs, avoid repeated resolve()
693693
auto temp_id = ns.intern("chamber.temp");
694694
// Use temp_id many times
695695
```
696696

697-
3. **Minimize graph complexity:**
697+
1. **Minimize graph complexity:**
698698

699699
- Fewer edges = faster execution
700700
- Long transform chains = more overhead
701701

702-
4. **Choose appropriate dt:**
702+
1. **Choose appropriate dt:**
703703

704704
- Too small: wasted computation
705705
- Too large: instability
706706
- Use model.compute_stability_limit() as guide
707707

708-
5. **Profile before optimizing:**
708+
1. **Profile before optimizing:**
709709

710710
- Run benchmarks (see tests/benchmarks/)
711711
- Most time typically in models, not transforms

docs/graph-visualization.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -61,10 +61,11 @@ Guarantees:
6161
6262
1. Emitter always writes node IDs and edge labels as quoted DOT strings.
6363
2. Escape rules:
64+
6465
- `\` -> `\\`
6566
- `"` -> `\"`
6667
- newline -> `\n`
67-
3. Signal paths containing `/`, `.`, spaces, or other punctuation are preserved via quoting.
68+
1. Signal paths containing `/`, `.`, spaces, or other punctuation are preserved via quoting.
6869
6970
## 6.2 Ordering Rules
7071
@@ -107,12 +108,16 @@ Exit codes:
107108
## 8. Evidence Mapping
108109
109110
1. Deterministic DOT output:
111+
110112
- `tests/unit/viz_dot_emitter_test.cpp`
111113
- `tests/unit/viz_dot_golden_test.cpp`
112-
2. CLI DOT determinism end-to-end:
114+
1. CLI DOT determinism end-to-end:
115+
113116
- `tests/integration/diagram_cli_e2e.cmake` (registered as `integration.diagram_cli_json_dot`)
114-
3. Core isolation:
117+
1. Core isolation:
118+
115119
- default presets keep `FLUXGRAPH_BUILD_DIAGRAM_TOOL=OFF`
116-
4. Renderer coverage in CI:
120+
1. Renderer coverage in CI:
121+
117122
- `linux-matrix` lane `diagram-dot`
118123
- `diagram-render-smoke` job in `.github/workflows/ci.yml`

docs/schema-json.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -438,7 +438,7 @@ Low-pass filter: `tau * dy/dt + y = x`
438438
}
439439
```
440440

441-
**Frequency Response:** 3dB cutoff at f_c = 1 / (2*pi * tau)
441+
**Frequency Response:** `3dB cutoff at f_c = 1 / (2*pi*tau)`
442442

443443
### 3. Delay Transform
444444

docs/schema-yaml.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,7 @@ edges:
409409
tau_s: 0.5
410410
```
411411

412-
**Frequency Response:** 3dB cutoff at f_c = 1 / (2*pi * tau)
412+
**Frequency Response:** `3dB cutoff at f_c = 1 / (2*pi*tau)`
413413

414414
### 3. Delay Transform
415415

0 commit comments

Comments
 (0)