Clean up documentation per the documentation conventions#480
Merged
Conversation
Fold configuration.md's restated env-var documentation into pointers to the variables' home tables in README.md and deployment.md. Drop justification sentences, roadmap notes, named-client example lists, and a doc-about-itself sentence; keep the contracts they surrounded. Fix grammar in the README install steps and move a misplaced remark in testing.md next to the command it qualifies. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
alistair3149
marked this pull request as draft
July 23, 2026 15:23
Compress "How the proxy works" to the facts an admin acts on: the bearer at /mcp is a proxy-minted token, the MediaWiki token stays server-side and is refreshed through the confidential consumer, and the per-wiki challenge behaviour. This also removes the claim that the proxy brokers the upstream consumer as a public + PKCE client, which the confidential-consumer requirement made stale. Shorten the per-request bearer discovery walkthrough to its contract, drop the spec-alignment design note, and cut the GIT_SHA label explanation to a clause. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The "HTTP transport behaviour" subsection of configuration.md described deployment behaviour — discovery publishing, 401 challenge conditions, per-request bearer semantics, session TLS guidance — to the config-file reader. Merge its unique facts into deployment.md's per-request bearer section, which also resolves the tension between "single-wiki only for now" there and the multi-wiki-per-session semantics here, and leave a pointer. Shrink README's internal-vs-public paragraph to a note, with the link-construction contract now under the per-wiki fields it belongs to, and cut the README security bullet that repeated the outbound SSRF-guard reference nearly verbatim. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
alistair3149
marked this pull request as ready for review
July 23, 2026 15:29
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.
A pass over the prose documentation applying docs/documentation-conventions.md (#479).
configuration.mdrestated the four hosted-proxy environment variables (semantics, defaults, duration grammar, activation conditions) and two core OAuth variables whose homes are thedeployment.mdand README tables. Both subsections are now short pointers; theMCP_PUBLIC_URLdiscovery-role fact, which had no other home, is kept.configuration.md's "HTTP transport behaviour" subsection described deployment behaviour — discovery publishing,401challenge conditions, per-request bearer semantics, session TLS guidance — to the config-file reader. Its unique facts merge intodeployment.md's per-request-bearer section (also resolving the tension between "single-wiki only for now" there and the multi-wiki-per-session semantics here), with a pointer left behind. README's "Internal vs public address" paragraph shrinks to a note, its link-construction contract moving under the per-wiki fields; the README security bullet that repeated the outbound SSRF-guard reference nearly verbatim becomes a pointer.deployment.md: "How the proxy works" is compressed to the facts an admin acts on — the/mcpbearer is a proxy-minted token, the MediaWiki token stays server-side and is refreshed through the confidential consumer, and the per-wiki challenge behaviour. This also removes the stale claim that the proxy brokers the upstream consumer as a public + PKCE client, which the confidential-consumer requirement obsoleted. The per-request-bearer discovery walkthrough shrinks to its contract and the spec-alignment design note is dropped./var/www/htmlremark intesting.mdnext to the command it qualifies; theGIT_SHAbuild-arg explanation cut to a clause.Considered, omitted:
configuration.md's "For wiki admins" section addresses a second reader, but it is explicitly labelled and the wiki-side half of the setup has no better home.deployment.md's env-var tables, security checklist, Host/Origin matching edge cases, SSRF-guard rules, persistence, and v1 limitations: all actionable for the admin reader, left intact.testing.md's e2e proxy walkthrough,operations.md, andreleasing.mdmatch their genre readers; no changes beyond the above.🤖 Generated with Claude Code