docs: feature-first README + application-level architecture diagram #79

Closed
opened 2026-10-25 04:16:20 -05:00 by yuuhikaze · 0 comments
Owner

The README is still shaped like the old one: too much technical furniture, and the architecture diagram depicts our deployed instance (Cloudflare, Traefik, Authelia) instead of the application. rgxr is self-hostable on its own — SSO/AD is optional, and an unauthenticated visitor is an anonymous user by default.

Scope:

  • README prose leads with features (editor, traces, algebra, regex⇄FA, grammars, PDA/TM, dojo, i18n, render/export), tech details shrink
  • Architecture mermaid shows the app topology: browser → rgxr-web → rgxr-api → Postgres, identity = anonymous by default + optional forward-auth SSO
  • Sweep docs/*.md for the same deployed-instance bias (reference.md auth model, index, development, design); operations.md may keep the deployment specifics but framed as our example
  • Regenerate docs-html with tern
The README is still shaped like the old one: too much technical furniture, and the architecture diagram depicts *our deployed instance* (Cloudflare, Traefik, Authelia) instead of the application. rgxr is self-hostable on its own — SSO/AD is optional, and an unauthenticated visitor is an anonymous user by default. Scope: - README prose leads with features (editor, traces, algebra, regex⇄FA, grammars, PDA/TM, dojo, i18n, render/export), tech details shrink - Architecture mermaid shows the app topology: browser → rgxr-web → rgxr-api → Postgres, identity = anonymous by default + optional forward-auth SSO - Sweep docs/*.md for the same deployed-instance bias (reference.md auth model, index, development, design); operations.md may keep the deployment specifics but framed as our example - Regenerate docs-html with tern
Sign in to join this conversation.
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
k8s-services/rgxr#79
No description provided.