docs: rework the public docs; move internal docs out of the repo - #114
Merged
windischb merged 2 commits intoJul 17, 2026
Merged
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
…nal docs out of the repo Public docs (docs/) are now the only documentation tree in the repo, serving end users, realm admins, sysadmins, integrators and a slim contributor section. Internal design notes live exclusively in the maintainers' knowledge base. - Audit every public page against the code (84 pages, 65 flagged): fix stale claims (SAML "not supported", 7-day audit retention, hard-delete "roadmap item", outdated sidebar/flow descriptions, missing endpoints in the API reference), remove maintainer-internal content (file:line citations, project codenames, engineering changelogs), and document recently shipped features (invite codes, per-realm rate limits, realm provisioning, device flow, native grants, CIMD, registration fields, app settings cascade, clone). - New page: admin/invite-codes (ADR-0012 admin surface + M2M minting). - integrate/scheduling removed from the public site (backend contributor guide, relocated to the internal knowledge base). - dev-docs/ deleted: architecture blueprints, engineering gotchas, future-feature designs, product matrices and upstream requests are migrated to the internal knowledge base (statuses corrected to reflect what has shipped). - Sweep every remaining dev-docs reference: nav config, PR template, CI workflows, CodeQL config, SECURITY.md, Dockerfile, .gitignore/ .dockerignore and ~27 source-comment pointers. - contribute/ stays public but slim: testing pages rewritten as current references; manual checklist is now a maintained smoke checklist instead of a session log. Docs build (dead-link gate) green; unit-test project compiles. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…ll dump /llms.txt is the llms.txt-standard entry point (6 KB index linking the per-page .md exports); /llms-full.txt (~700 KB) stays available and is still advertised via the <link rel="alternate"> head entry. 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
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.
Motivation
The VitePress site (docs/) is now the only documentation tree in the repo, serving end users, realm admins, sysadmins, integrators and a slim contributor section. Internal design notes, architecture blueprints, engineering gotchas and feature-design records have moved to the maintainers'' knowledge base and dev-docs/ is removed.
What changed
Public docs — audited against the code (84 pages, 67 updated):
Repo hygiene:
Tests
Breaking changes
🤖 Generated with Claude Code