Skip to content

docs: clear all STE100 prose findings (#163) - #245

Open
castrojo wants to merge 1 commit into
tuna-os:mainfrom
castrojo:fix/ste-prose-findings
Open

castrojo wants to merge 1 commit into
tuna-os:mainfrom
castrojo:fix/ste-prose-findings

Conversation

@castrojo

Copy link
Copy Markdown
Contributor

Clears all 110 Simplified Technical English (STE100) prose findings tracked in #163.

Every remaining finding across the tracked docs is fixed by rewriting prose — never by disabling a rule:

  • docs/USER_GUIDE.md (31): split over-long sentences, drop passive voice, break noun clusters, drop disallowed -ing forms.
  • docs/observability.md (33 = the 27 + 6 rows that share the file): active voice, shorter sentences, broken noun clusters.
  • CONTRIBUTING.md (11), README.md (10), docs/recipes/auto-captions.md (8), docs/adr/0004-vello-uri-bridge.md (7), docs/adr/0001-rust-ges-gtk-stack.md (6), docs/adr/0002-json-document-ts-scripting.md (4): same prose rewrites.

.ste-budget is set to 0 so the CI STE gate holds at zero findings.

Closes #163


🐝 Hive Agent: contributor | SHA: cdee874

Rewrite every remaining Simplified Technical English finding across
docs/USER_GUIDE.md, docs/observability.md, CONTRIBUTING.md, README.md,
docs/recipes/auto-captions.md, and docs/adr/0001-0002-0004: split
over-long sentences, replace passive voice with active, break noun
clusters, and drop disallowed -ing forms. Set .ste-budget to 0 so CI
holds the gate at zero findings.

Closes tuna-os#163
@tuna-reef-hive

Copy link
Copy Markdown

stage 080-awaiting-merge-admission → 050-review-pending: contributor-lane:no-claim

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Simplified Technical English: 110 findings to clear

1 participant