Skip to content

INDEX.md

Latest commit

 

History

History
27 lines (21 loc) · 2.66 KB

INDEX.md

File metadata and controls

27 lines (21 loc) · 2.66 KB
Raw

Agents Docs — Index

⚠️ These docs may be out of date. They are point-in-time snapshots written to give an agent (or human) a fast high-level overview of an unfamiliar area — not a substitute for the source of truth. Always verify against the current code before relying on file paths, line numbers, method names, or specific behaviors. If you find a doc has drifted, update it as part of your change.

This index points to the per-subsystem docs. Start with Project Architecture for the top-level map; jump to a specific area below.

Architecture

  • Project Architecture — Top-level map with subsystem links and critical gotchas
  • Auth & Users — HCA OAuth, trial users (STI), session management, before-action chain, Pundit
  • Projects & Journals — Core domain: projects, journal entries, recordings, ships, collaboration
  • Path & Gamification — 3D path progression, critters (gacha), koi/gold ledger, admin review pointers
  • Bulletin Board — Public community hub at /bulletin_board, bulletin events lifecycle, admin event management
  • Explore Feed — Public discovery for projects/journals (in-app feed + /api/v1/explore API), cursor pagination, search, live updates
  • Frontend — React 19 + Inertia + Tailwind 4, pages, components, styling, state management
  • Services & Infra — HCA, Lapse, Lookout, Slack, YouTube, Airtable, jobs, storage, monitoring
  • Cross-Cutting Patterns — Soft-delete, Pundit conventions, Flipper flags, PaperTrail, encryption

Deep-Dives

  • Ship Pipeline & Koi/Gold Economy — Preflight, identity gate, multi-stage review (TA/RC/DR/BR), claim/heartbeat, re-ship, DR=koi / BR=gold awarding, built-irl conversion sweep, edge cases
  • Project Grants & HCB Ledger — Two-table ledger (orders + topups), settle service, card lifecycle, closure refund auto-booking, divergence detection, admin UI scoping
  • HCB API v4 docs — OAuth flow, token lifecycle, scopes, card grants, transactions, organizations
  • Lookout API docs — Full endpoint reference for Lookout (video recording service)
  • Inertia Modal fork — Custom duration prop, in-modal navigation, modified files
  • Path 3D rendering — CSS perspective math, billboard system, canvas grass, curvature
  • Path performance — Optimization strategies (implemented and remaining)