docs: build a Diátaxis documentation site and slim the README - #24
Merged
Merged
Conversation
Restructure the documentation into a Diátaxis-organized MkDocs site: a hands-on tutorial, eleven task-focused how-to guides (including a migration guide from mock-oauth2-server), five reference pages, and four explanation pages, wired into the nav and building under mkdocs --strict. Shrink the README from 438 lines to a ~120-line entry point (description, features, quickstart, a documentation map, development), moving the flag reference, TLS/proxy/tracing how-tos, and release-chain detail into the site. Absorb contributor detail (project layout, tests, common tasks) into CONTRIBUTING.md and refresh its stale template framing. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
Summary
Reworks the documentation ahead of the v0.1.0 release. The 438-line README tried to be product intro, full flag reference, how-to collection, and release-design doc all at once; this splits that into a proper Diátaxis-organized MkDocs site and shrinks the README to an entry point.
New docs site (
docs/docs/, wired into the nav)docker runthrough the full authorization-code flow, token decode, userinfo, and a first/_mock/mint./_mock) · Observability.README + CONTRIBUTING
client_credentialstoken), a by-need documentation map linking the site, and a short development section. The flag table, TLS/proxy/tracing how-tos, project layout, container-build lore, and release-chain design all move into the site or CONTRIBUTING.Verification
moon run docs:build(mkdocs build --strict) passes: no broken links, nav matches disk, 24 pages.sub,azp/tidscoping,aud=[client_id]), single-use-codeinvalid_grant,/_mock/mintround-trip, and the dummy-signature jwt-bearer recipe all behave as documented.ghdreferences (removed in ci(release): drop the ghd distribution integration and fix the openapi smoke tests #22).Authored with multi-agent orchestration. No product code changed.
🤖 Generated with Claude Code