docs: correct stale claims, fix navigation, add lib READMEs#3
Merged
Conversation
Following a multi-agent documentation review, fix doc↔code drift across the family (no behavior changes — docs, comments, and one OpenAPI enum): - mini-directory↔issuers: correct stale "future work / stands alone" claims — mini-idp is wired and required (no local client registry); mini-oidc resolves humans optionally. Touches mini-directory openapi/ServerMain/build, DIRECTION catalog+roadmap, CLAUDE.md. - Stale class names: KeyAuthorizationPolicy/AllowAllPolicy were renamed to mini-policy's PolicyEngine/AllowAllPolicyEngine — swept repo-wide (READMEs, DIRECTION, honest-seams, GLOSSARY, openapi, lib javadoc), preserving the wired-vs-designed framing; KeyOperation left intact. - Accuracy fixes: mini-oidc OpenAPI PKCE enum [S256] (drop plain); remove the nonexistent mini-oidc signing-key rotation route from a howto; drop --secure-cookies misattributed to mini-gateway (3 spots); ClientRegistryMigration grants[] field-name javadoc; mini-ca PoP string; tutorial POST->PUT; diagram return=->rd; mini-kms config rows. - Navigation: single README front door (TEACHING); relabel TEACHING-OUTLINE as a realized historical doc; GLOSSARY -> TEACHING. - Pedagogy: name least-privilege and confused-deputy; add a CSRF reflex; GLOSSARY entries for CSRF, least-privilege, confused-deputy, cnf. - Add READMEs for libs/mini-token and libs/mini-policy (were missing). Co-Authored-By: Claude Opus 4.8 (1M context) <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
1 participant
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 multi-agent documentation review of the family surfaced doc↔code drift, navigation friction, and two missing READMEs. This PR fixes all findings. No behavior changes — docs, code comments/javadoc, and one OpenAPI enum value only.
./gradlew buildis green.Accuracy (doc said X, code does Y)
--directory-urland authenticates every/oauth/tokenagainst the directory; no local client registry). Corrected the stale "future work / not yet wired / stands alone" claims in mini-directory'sopenapi.yaml/ServerMain/build.gradle.kts, the DIRECTION catalog + Phase 3 roadmap, andCLAUDE.md. mini-oidc's optional/in-memory-fallback nuance preserved.KeyAuthorizationPolicy/AllowAllPolicywere renamed/generalized into mini-policy'sPolicyEngine/AllowAllPolicyEngine— swept repo-wide (service READMEs, DIRECTION, honest-seams, GLOSSARY, OpenAPI, and both libs' javadoc), preserving the wired-vs-designed framing.KeyOperation(which exists) left untouched.code_challenge_methodenum[S256, plain]→[S256](code rejectsplain).--secure-cookiesmisattributed to mini-gateway (3 occurrences); fixed startup-error attribution.ClientRegistryMigrationgrants[]field-name javadoc; mini-ca PoP string + bootstrap wording; tutorialPOST→PUT; diagramreturn=→rd; mini-kms config-table rows (--idle-timeout-ms,--max-connections).Navigation
TEACHING-OUTLINE.mdrelabeled as a realized historical design doc (was a stale "nothing written yet" blueprint linked from the learner's entry point); GLOSSARY points at TEACHING.Pedagogy
cnf.New
libs/mini-token/README.mdandlibs/mini-policy/README.md(the two foundational libs had none).🤖 Generated with Claude Code