Skip to content

Commit 5b8663e

Browse files
committed
Apply prettier formatting to ADR, plan, and issue docs
1 parent 5a4c336 commit 5b8663e

5 files changed

Lines changed: 186 additions & 187 deletions

File tree

docs/dev/adrs/accepted/documentation-ci-build.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -82,14 +82,14 @@ allowlist for crystallographic terms, package names, and CIF tags.
8282
Most of this ADR is already in place; it is accepted to record the
8383
chosen direction and to track the remaining gaps.
8484

85-
| # | Decision | Status |
86-
| - | -------- | ------ |
87-
| 1 | MkDocs `--strict` build | **Done**`docs-build` pixi task runs `mkdocs build --strict`; wired into the `lint-format.yml` "docs strict build" gate and the `docs.yml` deploy workflow. |
88-
| 2 | `mkdocstrings` for API pages | **Done**`mkdocstrings` + `mkdocstrings-python` configured in `docs/mkdocs.yml` (handler `paths: ['src']`); the `api-reference/*.md` pages use `:::` directives. |
89-
| 3 | Snippet smoke tests | **Not done** — no task imports or executes the user-facing snippets in `quick-reference/`, `user-guide/first-steps.md`, or `user-guide/analysis-workflow/*.md`. Highest-value remaining gap. |
90-
| 4 | Tutorial freshness check | **Partial**`notebook-prepare` plus `notebook-tests`/`notebook-exec-ci` exist, but no no-write task asserts that `notebook-prepare` leaves the committed `.ipynb` unchanged. |
91-
| 5 | `lychee` link checking | **Done for local/relative links**`link-check` pixi task (config in `lychee.toml`) is wired into `lint-format.yml`. External-URL checking is deferred (see issue 114). |
92-
| 6 | `codespell`, then `Vale` | **codespell done**`spell-check` pixi task wired into `lint-format.yml`. `Vale` deferred. |
85+
| # | Decision | Status |
86+
| --- | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
87+
| 1 | MkDocs `--strict` build | **Done**`docs-build` pixi task runs `mkdocs build --strict`; wired into the `lint-format.yml` "docs strict build" gate and the `docs.yml` deploy workflow. |
88+
| 2 | `mkdocstrings` for API pages | **Done**`mkdocstrings` + `mkdocstrings-python` configured in `docs/mkdocs.yml` (handler `paths: ['src']`); the `api-reference/*.md` pages use `:::` directives. |
89+
| 3 | Snippet smoke tests | **Not done** — no task imports or executes the user-facing snippets in `quick-reference/`, `user-guide/first-steps.md`, or `user-guide/analysis-workflow/*.md`. Highest-value remaining gap. |
90+
| 4 | Tutorial freshness check | **Partial**`notebook-prepare` plus `notebook-tests`/`notebook-exec-ci` exist, but no no-write task asserts that `notebook-prepare` leaves the committed `.ipynb` unchanged. |
91+
| 5 | `lychee` link checking | **Done for local/relative links**`link-check` pixi task (config in `lychee.toml`) is wired into `lint-format.yml`. External-URL checking is deferred (see issue 114). |
92+
| 6 | `codespell`, then `Vale` | **codespell done**`spell-check` pixi task wired into `lint-format.yml`. `Vale` deferred. |
9393

9494
## Options Considered
9595

@@ -198,8 +198,8 @@ Cons:
198198
question carried into that plan: extract fenced code blocks
199199
automatically or rely on explicitly named snippets.
200200
- Add a no-write `notebook-prepare-check` task that fails CI when the
201-
committed notebooks are out of date with their `.py` sources
202-
(decision 4).
201+
committed notebooks are out of date with their `.py` sources (decision
202+
4).
203203
- Enable external-URL link checking in the docs gate (decision 5),
204204
scheduled or cached to avoid flakiness. Tracked by issue 114.
205205
- Adopt `Vale` prose linting once an EasyDiffraction style vocabulary

docs/dev/adrs/accepted/test-suite-and-validation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -450,8 +450,8 @@ such as `lychee`, and later `Vale`) used by §9.
450450
## Related ADRs
451451

452452
- [Test Strategy](../accepted/test-strategy.md) — amended by this ADR.
453-
- [Documentation CI and Build Verification](documentation-ci-build.md)
454-
coordinated with §9.
453+
- [Documentation CI and Build Verification](documentation-ci-build.md)
454+
coordinated with §9.
455455
- [Lint Complexity Thresholds](../accepted/lint-complexity-thresholds.md)
456456
— sibling Quality guardrail.
457457
- [Notebook Generation Source of Truth](../accepted/notebook-generation.md)

0 commit comments

Comments
 (0)