member-console/docs/README.md

title, audience, summary

title	audience	summary
Documentation index	developer admin user	Index of member-console documentation, grouped by audience, plus the front-matter convention every doc follows.

Documentation

Every document in this directory carries YAML front matter declaring its audience, so readers can find what's for them and contributors know who they're writing for.

Front-matter convention

Start each doc with a front-matter block:

---
title: "Human-readable title"
audience: [admin, developer]   # one or more of: developer, admin, user (primary first)
summary: "One sentence describing what the doc covers."
---

The three audiences:

• developer — contributing to or understanding the codebase: architecture, design decisions, dev setup, testing, UX research and conventions, the provider-extension contract.
• admin — hosting and operating an instance: installing, configuring an identity provider, building the image, generating secrets, running the service.
• user — the general public or a member using a running service. (None yet — the tag is reserved for member-facing docs.)

List the primary audience first; a doc may name more than one.

For administrators — hosting & operating

• Hosting member-console — build the image and generate secrets.
• Deployment Architecture — how the console fits alongside a public site and an identity provider.
• Identity Provider Setup — configure an OIDC IdP for login.
• Temporal Authorization Setup — emit the permissions claim Temporal's JWT authorizer expects.
• Plan Management — operator guide to plan ladders and grants.
• Stripe Integration — flags, secrets, webhooks, and purchasability.

For developers — contributing & internals

• Database Management — goose migrations and sqlc.
• Design System — UI conventions and the accessibility baseline.
• FedWiki Integration — provisioning via the FarmManager API.
• Grant / Plan Ladder Safety — the invariants that protect entitlements.
• HTMX Setup — HTMX under a strict CSP.
• Operator Information Architecture — the operator panel's IA contract.
• Operator UX Conventions — form and action conventions.
• Operator UX Research — the M7 UX research study.
• Operator UX Walkthrough Task — the screen-walkthrough briefing.
• Plan Architecture — how plan enrollment spans billing and entitlements.
• Building an Integration — adding a new integration.
• Testing — the test taxonomy and how to run each kind.
• operator-ux-walkthroughs/, operator-ux-walkthrough-evidence/ — captured UX walkthrough evidence.

For users

No member-facing documentation yet.