Repository navigation
docs(site): tighten documentation prose and state each rule once - #408
Merged
Merged
Conversation
An editorial pass over the docs site removes contrasts and closing lines that restated the sentence before them, provenance narration in the generated reference pages, the contributor naming policy from the configuration pages, prose em dashes and curly quotes. The namespace access rule is stated in full on the capabilities page and linked from the pages that repeated it, and the MCP public-origin requirement lives in the MCP guide with a link from TLS. The install page keeps its steps and moves its lookup tables to the configuration reference. Generated text is changed at its source in cmd/fanout-docgen and internal/config, and the pages are regenerated.
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 changed
An editorial pass over fanout.run's documentation, from a site-wide review against Diátaxis and a writing-style checklist. URLs, slugs, page structure and code examples are unchanged.
cmd/fanout-docgen,internal/config) and regenerated.Verification
just checkjust test-racewhen auth, API, ingest, query, MCP, or agent paths changed (not applicable: documentation strings only)just docs-generate-check)Also:
just site-buildwith all site checks, lychee over the built site (2,315 links and anchors, 0 errors), and a Codex review of the diff (no findings).