Commit bb95582
Document inline vs file-based kinds selection criteria (#412)
* Mark plan 208 as complete; PR #391 merged 2026-05-24
* Add guide: choose between inline and file-based kinds
* Fold kind-form decision into file-kinds.md; drop standalone guide
Addresses /code-review findings on PR #412:
- Wrong Diatáxis type (was how-to, content is background/decision-aid).
Folded the unique 'when to keep inline / when to lift' selection
criteria into docs/guides/file-kinds.md as a new H2 above the
existing 'Split a kind into its own file' section, where it sits
next to the mechanics it points at.
- Removed the standalone guide and its catalog rows.
- Cut sections that duplicated file-kinds.md or kind-files.md:
the YAML side-by-side examples (closed: false would have errored
on a frontmatter-only schema), the 'what stays inline regardless'
block, the comparison table, and the 'mixing both forms' example
(which mislabeled this repo's inline kinds as file-based).
- Dropped the stale .mdsmith.yml line-count snapshot.
- Removed the 'maintenance decision, not a behavioral one' seesaw.
- New section uses zero em-dashes.
* Replace 'alt-tabbing' with 'switching' in file-kinds.md
Global-English pass: alt-tab is a Windows/Linux phrasal-verb idiom;
the plain verb 'switching' is keyboard-agnostic and reads on a
first pass for non-native readers.
* Address /code-review findings 1-5 on file-kinds.md
- F1: replace bare KindBody with 'body keys' (host page never defines
the typed term; reference page expects this guide to define it).
- F2: section-end pointer now goes directly to the kind-files reference
instead of the next H2 (which itself relayed there).
- F3: 'A PR touching X names itself' was an idiomatic personification;
rewrite as 'carries the kind name in its path'.
- F4: trim the 'Split a kind' H2 opener that re-stated the same trigger
the new decision-aid section above already delivered; H2 now opens
with the action.
- F5: 'outweighs the history isolation' used an undefined noun phrase;
expand to 'outweighs the gain of isolating each kind's edit history'.
---------
Co-authored-by: Claude <noreply@anthropic.com>1 parent 3f3e6f0 commit bb95582
3 files changed
Lines changed: 53 additions & 6 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
133 | 133 | | |
134 | 134 | | |
135 | 135 | | |
136 | | - | |
| 136 | + | |
137 | 137 | | |
138 | 138 | | |
139 | 139 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
230 | 230 | | |
231 | 231 | | |
232 | 232 | | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
| 267 | + | |
| 268 | + | |
| 269 | + | |
| 270 | + | |
| 271 | + | |
| 272 | + | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
| 276 | + | |
| 277 | + | |
| 278 | + | |
| 279 | + | |
| 280 | + | |
| 281 | + | |
| 282 | + | |
233 | 283 | | |
234 | 284 | | |
235 | | - | |
236 | | - | |
237 | | - | |
238 | | - | |
| 285 | + | |
239 | 286 | | |
240 | 287 | | |
241 | 288 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | 3 | | |
4 | | - | |
| 4 | + | |
5 | 5 | | |
6 | 6 | | |
7 | 7 | | |
| |||
0 commit comments