Skip to content

docs: tighten prose across documentation#110

Open
ian-flores wants to merge 4 commits intomainfrom
docs-prose-cleanup
Open

docs: tighten prose across documentation#110
ian-flores wants to merge 4 commits intomainfrom
docs-prose-cleanup

Conversation

@ian-flores
Copy link
Collaborator

@ian-flores ian-flores commented Mar 2, 2026

Summary

  • Removed AI-isms and inflated language across all 14 doc files (docs/, README, CONTRIBUTING)
  • Replaced copula avoidance patterns ("serves as", "stands as") with plain "is"/"are"
  • Cut filler transitions, hedging, and unnecessary adverbs ("comprehensive", "automatically", "ensure that")
  • Tightened prose to direct, declarative statements
  • Standardized verb usage ("verify" instead of mixed "ensure/check/confirm")

No technical content, code blocks, YAML, commands, or document structure changed. Net zero line count (406 insertions, 406 deletions).

Test plan

  • Verify all docs render correctly on GitHub
  • Spot-check a few files for accuracy (no meaning changes)

@claude
Copy link

claude bot commented Mar 2, 2026

Claude finished @ian-flores's task —— View job


Review Complete

  • Read review guidelines
  • Get PR diff and review changes
  • Submit review

The prose cleanup is solid — filler is removed, language is tighter, and no code/YAML/commands were touched. I found a few issues to flag (couldn't post inline comments due to permissions, so including them here):


Meaning Changes

  1. docs/architecture.md:94 — "You can attribute database connections to specific products" introduces second-person, inconsistent with the rest of the section. Original passive form ("Database connections can be attributed…") fits better.

  2. docs/architecture.md:370 — "It mirrors public repositories and hosts private packages" states these always happen. Original "It can mirror…and host…" correctly describes optional capabilities.

  3. docs/guides/connect-configuration.md:93 — "Re-enabling Connect after suspension requires…" conveys obligation. Original "is as simple as…" conveys ease. Consider: "To re-enable Connect after suspension, remove the field or set it back to true:"

  4. docs/guides/connect-configuration.md:79 — "Customer lacks a Connect license yet" is grammatically awkward ("lacks" and "yet" conflict). Consider: "Customer does not have a Connect license. Deploy the site without Connect and enable it once licensed."

  5. docs/guides/connect-configuration.md:100-102 — "When to use" items changed from gerund form ("Permanently decommissioning…") to imperative ("Permanently decommission…"). The original gerund form reads better as situation descriptions under a "when to use" heading.

Ensure vs. Verify

Throughout the troubleshooting and other guides, "ensure" was globally replaced with "verify." These words have different meanings:

  • Verify = confirm/check that something is true
  • Ensure = make it so / take action if needed

In troubleshooting solution steps (e.g., "Ensure the metadata URL is accessible from pods"), the intent is to fix the problem, not just check for it. "Verify" is appropriate in diagnostic steps. Consider restoring "ensure" where the intent is corrective action.

Structural Changes

In several files (troubleshooting.md, authentication-setup.md, workbench-configuration.md), numbered debugging/troubleshooting steps (e.g., 1. **Verify group claim is present:**) were flattened to unnumbered paragraphs with bold headings. The numbered-list format communicates sequential order and is standard for procedures. Consider preserving numbered lists in troubleshooting sections.


Copy link

@claude claude bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prose cleanup looks good overall — the changes remove filler and tighten language across the board. I found a few spots where the edits subtly shift meaning or introduce structural changes. Detailed feedback is in the PR comment.

Changes:
- Restore bold emphasis on safety-critical terms: **enabled by default** (off-host execution), **experimental** (SMTP), **single source of truth** (Site CRD), **squash merging** / **squash and merge** (CONTRIBUTING.md)
- Fix capability→assertion meaning shift in architecture.md: "It mirrors" → "It can mirror" for Package Manager
- Restore numbered lists in sequential troubleshooting/debugging steps across troubleshooting.md, authentication-setup.md, and workbench-configuration.md (token claim debugging, group membership, credential issues, TLS/certificates, volume permissions, OIDC callbacks, SAML metadata, token/claim problems, getting help, auth failures, session resource issues, volume mount issues)
- Restore passive voice for Chronicle sidecar injection (operator injects it, not itself)
- Restore "Can display" for Optional Academy (it's conditional)
- Restore "Important:" prefix for sessionImage note
@ian-flores ian-flores marked this pull request as ready for review March 2, 2026 21:29
@ian-flores ian-flores enabled auto-merge March 2, 2026 21:29
@ian-flores ian-flores requested a review from timtalbot March 2, 2026 21:29
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.

1 participant