Document inline vs file-based kinds selection criteria - #412
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files
☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
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.
- 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'.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Completes plan 208 by adding comprehensive guidance on when to declare kinds inline in
.mdsmith.ymlversus as standalone files under.mdsmith/kinds/.Summary
This PR adds a new guide document that helps users and maintainers decide between the two equivalent forms for declaring kinds. Both forms produce identical behavior; the choice is purely a maintenance and review ergonomics decision.
Changes
New guide:
docs/guides/inline-vs-file-kinds.md(168 lines)Plan status: Marked plan 208 as complete (✅)
Index updates: Added the new guide to
docs/guides/index.mdand updated agent instruction files to reference itImplementation notes
The guide follows the established pattern of decision-tree documentation (similar to the flavor/rule/convention/kind conceptual guide). It emphasizes that the two forms are behaviorally equivalent and frames the choice as a code review and maintenance concern rather than a technical one. The concrete line-count thresholds (50 lines for inline, 150 lines for file-based, 6 kinds as a breakpoint) are drawn from real experience with the project's own
.mdsmith.ymlconfiguration.https://claude.ai/code/session_01UhQDukgFDZXzgaaBFVSf1e