Repository navigation
docs: tighten documentation prose and state each rule once - #231
Merged
Merged
Conversation
An editorial pass over the docs site removes contrasts and closing lines that restated the sentence before them, slogans, provenance narration in generated pages, and many prose em dashes. Claims repeated across pages (the guarantees Onebox does not make, rollback versus data recovery, refused image guessing, codes as a contract) are stated once on the page that owns them and linked from the others. The upgrade guide puts its steps first, the install page explains the Buildx probe once, and two grammar errors are fixed. Generated text is changed in cmd/ob-docgen and regenerated; the drivers page now links PostgreSQL protection to the backups guide's enablement section.
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.
What this changes
An editorial pass over onebox.run's documentation, from a site-wide review against Diátaxis and a writing-style checklist. URLs, slugs and code examples are unchanged.
--formatprobe once; "A operator" and one agreement error are fixed.cmd/ob-docgenand regenerated. The drivers page now links PostgreSQL protection to the backups guide's "Declaring is not enabling" section.Why this is correct
just checkpasses, including the docgen check, site build, canonical and docs-URL checks.Effect on the safety envelope
None. Documentation wording only.
Checklist
just checkpasses locally.just checkverifies this).