docs: convert the shared camera includes to the house style - #594
Merged
Conversation
Full simplified technical English pass over docs/source/includes/camera_prep.rst docs/source/includes/camera_cable_connect.rst, applying the seven
rules and the approved-term table from the docs skill.
PASS docs/source/includes/camera_prep.rst
em-dash 1->0 | semicolon 2->0 | banned 0->0 | words 293->290 (-1%)
PASS docs/source/includes/camera_cable_connect.rst
em-dash 1->0 | semicolon 1->0 | banned 0->0 | words 157->152 (-3%)
OVERALL: PASS
Style only. No facts, numbers, procedures or step order were changed.
Headings, cross-references, image paths and substitutions are unchanged,
verified mechanically against origin/main. Sphinx builds clean under -n.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD
This was the only PR in the conversion that changed modality, and modality is meaning rather than style. Review flagged four places; all are restored. - "It should sit neatly in the square recess" and "It should stay open as you insert the cable" had both become "must". Each is arguable as a fit criterion, but the source hedged and a style pass should not decide that. - "It helps to remove the black plastic portion..." had become an imperative, which reads as a mandatory pliers-on-the-camera-PCB step. It is optional advice, so it is now "you can pull the black plastic part off". - "as close to the board as you reasonably can" had lost "reasonably". The rest of the conversion on these two files stands: the terminology unification (board -> PCB, piece -> clip) and the sentence splits are style, and every caution still reads with at least its original force. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD
"Flip the camera assembly over. Thread the lens in slowly and carefully. Use gentle force." is four sentences in a row for one careful movement, and a two-word imperative reads as a separate step. The style asks for shorter sentences, not staccato in a delicate procedure. No fact or instruction changed; the gentle force is now a condition of the same movement rather than a step of its own. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD
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.
Full simplified technical English pass over
docs/source/includes/camera_prep.rst and docs/source/includes/camera_cable_connect.rst, using thedocsskill's seven rules and approved-term table. Part of the manual-wide conversion, one PR per file.Measured change
What the converting agent reported
Safety
Style only. No facts, numbers, procedures or step order were changed.
Verified mechanically against
origin/mainthat every heading (text and underline character), every:ref:,:doc:, image path, substitution,include::and external URL is unchanged. Headings matter becauseautosectionlabelturns each one into a cross-reference target that other pages depend on, and a rename would break them silently.Sphinx builds clean under
-n(nitpicky).Any
FACT_CONCERNSabove were deliberately not fixed. They are reported for a maintainer decision, since changing them would be a content edit rather than a style one.🤖 Generated with Claude Code
https://claude.ai/code/session_01HqTCarGCgTRWBQ1ysG8XFD