docs: feature-first README, app-level architecture, opt-in auth and tutorial docs #83
Loading…
Reference in a new issue
No description provided.
Delete branch "docs/feature-first-readme"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Closes #79.
What changed
README.md — feature-first rewrite
USER: anonymous), SSO optional./api) → rgxr-api (axum, stateless) → Postgres (jsonb documents, per-user scoping), with a dotted identity edge: trusted proxy (optional SSO forward-auth) →remote-userheaders, else anonymous. Sensei/API-key and graphviz/LaTeX notes sit in prose below the one diagram.docs/reference.md
remote-user/remote-name/remote-email/remote-groupsheaders from a trusted proxy when present, otherwise the anonymous user; no more "prod missing header = 401". Sign-in is opt-in from the UI.rgxr-webenv varAUTH_SIGNIN_PATH(when unset, the UI hides sign-in) in its own row;RGXR_DEV_MODEmeaning updated (Vite-origin CORS; anonymous fallback is unconditional now).docs/operations.md — kept as the record of our production deployment (k8s, Authelia, Kargo lanes), explicitly framed as one way to run rgxr, not a dependency; the Auth section notes self-hosters need none of it.
docs/index.md — "self-hostable", anonymous visitors welcome, SSO opt-in.
Tutorials (issue #81, docs slice)
[ SHOW ME ]steps).web/src/lib/tutorial/as typed steps with inline en/es content (dojolines.tsprecedent).docs-html/ regenerated with tern (2/2 pipelines, 7 files). Links verified: sibling
.htmllinks and../resources/images/paths are intact — the forge rendering and the tern filter dependencies are untouched.Deliberately left alone: docs/dojo.md, docs/design.md theme (beyond the tutorials subsection),
web//crates//openapi.yaml/resources/images, and the README Screens table.