Enforce Posit doc style across all README files#80
Merged
bschwedler merged 4 commits intomainfrom May 8, 2026
Merged
Conversation
Apply Posit style guide rules: sentence-case headings, active voice, short-form `Connect` after first mention, replace em dashes with colons, spell out OCI on first use, link rstudio-docker-products, and end the license sentence with a period. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Apply Posit style guide rules: sentence-case headings, active voice, short-form `Connect` after first mention, expand contraction, replace `may` with `might`, drop possessive on Posit, spell out CVE on first use, link rstudio-docker-products, fix `UID/GID` slash, promote bold pseudo-headings to real subheadings, and convert inline `**Note:**` to a NOTE callout. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Apply Posit style guide rules: sentence-case headings, active voice, short-form `Connect` after first mention, spell out CVE on first use, link rstudio-docker-products, and lowercase `Posit product`. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Apply Posit style guide rules: sentence-case headings, active voice, short-form `Connect` after first mention, replace bold-concept-em-dash list items with colon run-ins, bold the full UI navigation path, and link rstudio-docker-products. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
bschwedler
approved these changes
May 8, 2026
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.
Summary
/doc-reviewer:doc-revieweragainst everyREADME.mdin the repository to enforce the Posit documentation style guide (sentence-case headings, active voice, short-formConnectafter first mention, no em dashes, no contractions, spelled-out acronyms on first use, etc.).connect,connect-content,connect-content-init), one commit per file for easy review.rstudio-docker-productsreference in each preview-status NOTE callout, promoted bold pseudo-headings inconnect/README.mdto real subheadings, and replaced LLM-style bold-concept-em-dash list items inconnect-content/README.mdwith colon run-ins.The intent is for
/doc-reviewer:doc-reviewerto be the standing mechanism for keeping these files aligned with Posit documentation standards going forward.Test plan
connect,connect-content,connect-content-init) on Docker Hub once a build pushes/doc-reviewer:doc-reviewerto confirm no remaining high/medium violations🤖 Generated with Claude Code