Skip to content

Latest commit

 

History

History
50 lines (37 loc) · 6.09 KB

File metadata and controls

50 lines (37 loc) · 6.09 KB

LearnStack Hub — Documentation Catalogue

Hub documentation is intentionally slim. Cross-cutting architectural decisions live in the LearnStack core repository and Hub docs link to them rather than restating them. What lives here is what only the Hub can own:

  1. The Hub roadmap — the plan for this repository, one document per packet
  2. Hub-internal architecture (repository layout, module topology, the contract pointers)
  3. Hub module deep-dives (Hub-only implementation details)
  4. Hub-internal ADRs (decisions that affect only the Hub)
  5. Hub operational runbooks
  6. Hub-specific glossary terms

Directory layout

Directory Purpose Numbering
roadmap/ The authoritative Hub plan. One document per packet (P02c-0P02c-7) plus the post-02c billing and marketplace tracks. Not a mirror of a LearnStack file — LearnStack's phase-02c covers only its own side of the boundary and links here for the rest. pNNc-N-topic.md
architecture/ Hub-internal architecture — repository layout, module topology, cross-cutting foundation, entitlement projection — plus the contract pointers to LearnStack core flat, unnumbered
decisions/ Hub-internal ADRs (Hub-only decisions; HUB-NNNN series so they never collide with LearnStack ADR numbers) HUB-NNNN-topic.md
operations/ Hub operational runbooks (deployment, incident response, cert rotation) unnumbered
modules/ Per-Hub-module deep dives + audit-coverage matrices per-module files
glossary.md Hub-specific terms (Plan, HubSubscription, Entitlement, Hub Operator) single file

Every roadmap packet document carries the same six sections as a LearnStack phase document: Goal, Scope, Deliverables, Completion Criteria, Risks, Phase Exit Decision.

Authoritative cross-cutting docs (LearnStack core, not here)

Hub docs cite these by absolute URL (https://github.com/HodeTech/LearnStack/blob/main/docs/...), per Documentation Standards § Layout. Relative paths do not cross a repository boundary on github.com and depend on a sibling checkout being present and identically capitalised.

Engineering standards

Hub follows LearnStack's Standards corpus by reference. Hub does not maintain its own standards. If a Hub-internal-only rule emerges (for example a Stripe webhook idempotency strategy), it lands as a Hub-internal ADR (HUB-NNNN), not as a standards file.

Skills

This repository maintains its own skill catalogue at .claude/skills/ — 18 skills, git-tracked through an un-ignore rule in .gitignore. Agents running from the Hub repository root load them from there, not from the sibling LearnStack repo.

The catalogue is Hub-tailored: the add-hub-* workflows encode Hub's deltas from LearnStack core — no Row Level Security, OperatorId rather than UserId, a six-step MediatR pipeline rather than eight, the hub schema, the learnstack_hub database. Entry-point selection is unchanged: implement-task for substantive work, start-task for scoping, standards-check then code-review for review.