Appendix

Need the lay of the land or the rules-of-the-road? This appendix has the answers.

Repo layout (TL;DR)

docs/                    # planning notes, schema drafts, task lists
supabase/
  functions/             # Edge functions (rss-fetch, twitter-fetch)
  migrations/            # SQL migrations (0001_init.sql, ...)
web/
  src/app/               # App Router routes + API handlers
  src/components/        # HUD components
  src/lib/               # Supabase clients, utilities
  src/store/             # Zustand slices
astro-book/              # This documentation site (Astro)

Code style & linting

  • TypeScript with sensible strictness; try to keep lines ≤ 100 chars.
  • ESLint 9 + eslint-config-next@15.5.3 guardrails.
  • Tailwind v4 tokens driving most styling; custom CSS only when necessary.
  • For docs, we stick with Markdown + MDX rendered through Astro.

Contribution checklist

  • npm run lint and npm run build before every PR (both web/ and astro-book/ if touched).
  • Update or create ADRs when you make architectural shifts.
  • Add tests (unit or integration) when new API routes or ingestion behavior ships.
  • Touch this book whenever the public surface area changes—docs should evolve with the product.

License

  • The docs app (astro-book/) ships under MIT (see astro-book/LICENSE).
  • The main HUD app currently defaults to All Rights Reserved; add MIT/Apache-2.0 if you intend to open source it.