docs: correct dash style and attribution wording - #112
Merged
Conversation
The plain-dash repo style rule in firstmate-coding-guidelines was broken in docs/arm-pretool-check.md and docs/decision-hold-lifecycle.md, where a paired em dash carried a parenthetical in each file. README.md introduced the third-party attribution list with "both from", which became false when the list grew to three entries. "all from" is true for the current three and stays true as the list grows. Text only: no behaviour, script, or contract text changes.
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
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.
Intent
Fix three text-only defects in the firstmate instruction surface that were found by the documentation gate of the fm-adopt-domain-modeling work on 2026-08-03 and deliberately deferred by the captain so that proposal stayed narrow and reviewable.
docs/arm-pretool-check.md and 2. docs/decision-hold-lifecycle.md each violated the plain-dash repo style rule owned by the firstmate-coding-guidelines skill ('Plain dash -, never an em dash'). The recorded line numbers (24 and 31) were known to be stale, so the task explicitly required verifying them rather than trusting them. Verified: the offending characters are now at line 28 in arm-pretool-check.md and still line 31 in decision-hold-lifecycle.md. Each file contained exactly one PAIRED em dash (two characters) wrapping a parenthetical, not a single dash. Both files were then swept for the whole em/en/figure/minus dash class (U+2010-U+2015, U+2212) and confirmed clean.
README.md line 253 (recorded as ~228) introduced the third-party attribution list with 'Third-party material, both from mattpocock/skills'. The list has grown to THREE entries (sea-chart, to-backlog, domain-modeling), so 'both' is a false statement. This was explicitly NOT a licensing problem - the attributions themselves are complete and correct - only a wrong word. The requirement was that the wording be true for three entries AND stay true if a fourth is added, so 'both' was changed to 'all' rather than to 'three': 'all' is count-independent and does not need editing again when the list grows.
Deliberate constraints on this task: no behaviour, script, or contract text changes of any kind. The diff is exactly three single-line prose edits across three Markdown files. The em-dash replacements preserve the surrounding sentence and its parenthetical structure verbatim apart from the two dash characters in each. No tests were added, because there is no behaviour here to assert - the changes are prose in human-facing documentation, and the plain-dash rule is a style convention in a skill, not an enforced check. The repo's one-sentence-per-line Markdown rule is preserved: no line was split or joined.
What Changed
Risk Assessment
✅ Low: The change is limited to exactly three intended single-line documentation corrections, preserves the surrounding prose and line structure, and introduces no source or lifecycle risk.
Testing
No baseline test output was supplied; targeted diff and semantic checks confirmed exactly three prose substitutions, preserved line counts, clean prohibited-dash scans, truthful count-independent attribution wording, and a clean worktree. The final excerpts provide direct reviewer-visible evidence; no screenshot was created because the changed surface is plain Markdown prose with no visual layout or UI behavior.
Evidence: Final user-facing documentation excerpts
Pipeline
Updates from git push no-mistakes
✅ **intent** - passed
✅ No issues found.
✅ **Rebase** - passed
✅ No issues found.
✅ **Review** - passed
✅ No issues found.
✅ **Test** - passed
✅ No issues found.
git diff --stat 8725f8124d786b1f4cdbf54ab25153d40d8bb412..8ea25e89e86b531e4e1389fc8472ee1c9a5d05d0git diff --unified=3 8725f8124d786b1f4cdbf54ab25153d40d8bb412..8ea25e89e86b531e4e1389fc8472ee1c9a5d05d0 -- README.md docs/arm-pretool-check.md docs/decision-hold-lifecycle.mdFocused Python semantic comparison of each target blob against its base blob, asserting the exact intended substitution was the only content change and line counts were preservedFocused Unicode scan of both documentation blobs for U+2010–U+2015 and U+2212Focused README attribution check confirming count-independent “all” introduces the three current entriesCommit-scope check asserting exactly three changed files with one removed and one added line eachgit status --short✅ **Document** - passed
✅ No issues found.
✅ **Lint** - passed
✅ No issues found.
✅ **Push** - passed
✅ No issues found.