Skip to content

Commit 00077af

Browse files
committed
Fix markdown lint: fenced block languages, TOC entry, setext heading
1 parent 0efdefa commit 00077af

5 files changed

Lines changed: 8 additions & 7 deletions

File tree

docs/contributing/howto-organize-poc-output.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Place results in `docs/design/<feature>/poc-results/`.
1111
Name files with a numeric prefix that reflects reading order. Order them by
1212
usefulness for the human reviewer:
1313

14-
```
14+
```text
1515
poc-results/
1616
├── 01-poc-report.txt — findings, methodology, implications
1717
├── 02-conversation-log.txt — human-readable record of the PoC

docs/contributing/templates/jira-ticket-template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
**Agentic tool instruction**: TODO
1414

15-
```
15+
```text
1616
Read the "[section]" section in docs/design/<feature>/<feature>.md.
1717
Key files: [files].
1818
```

docs/contributing/templates/spec-doc-template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ TODO: User stories in "As a [role], I want [X], so that [Y]" format.
3737

3838
TODO: Flow diagram showing the request/response path with the new feature.
3939

40-
```
40+
```text
4141
TODO: flow diagram
4242
```
4343

docs/contributing/templates/spike-template.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,15 @@ TODO: Use the format from `docs/contributing/templates/jira-ticket-template.md`.
4646

4747
**Scope**: TODO
4848

49-
-
49+
- TODO
5050

5151
**Acceptance criteria**: TODO
5252

53-
-
53+
- TODO
5454

5555
**Agentic tool instruction**: TODO
5656

57-
```
57+
```text
5858
Read the "[section]" section in docs/design/<feature>/<feature>.md.
5959
Key files: [files].
6060
```
@@ -66,7 +66,7 @@ TODO: If a PoC was built, document what it does, what it proved, and how it dive
6666
## What the PoC does
6767

6868
**Important**: The PoC diverges from the production design in these ways:
69-
-
69+
- TODO
7070

7171
## Results
7272

docs/contributing_guide.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
* [PR description](#pr-description)
1111
* [Definition of Done](#definition-of-done)
1212
* [A deliverable is to be considered “done” when](#a-deliverable-is-to-be-considered-done-when)
13+
* [Feature design process](#feature-design-process)
1314
* [AI assistants](#ai-assistants)
1415
* [“Mark” code with substantial AI-generated portions.](#mark-code-with-substantial-ai-generated-portions)
1516
* [Copyright and licence notices](#copyright-and-licence-notices)

0 commit comments

Comments
 (0)