Skip to content

README.md

Latest commit

 

History

History
42 lines (31 loc) · 2.87 KB

README.md

File metadata and controls

42 lines (31 loc) · 2.87 KB
Raw

CodeRoastWeb Technical Documentation

This folder documents the CodeRoast website, LogCraft Playground, and Insight Playground clients. The app is no longer only a portfolio page: it is also the browser control surface for live LogCraft engines and server-side InSight explanations.

Read Order

  1. architecture.md - routes, component boundaries, state stores, REST/WebSocket client model, Lab lifecycle.
  2. deployment.md - local dev, build, Netlify, VITE_API_BASE, Vite proxy, and backend expectations.
  3. i18n.md - EN/FR translation structure, type safety, and locale workflow.
  4. theming.md - dark-first UI system, Tailwind brand palette, animations, and design constraints.

AI Quick Path

For a fast pass, read:

  1. architecture.md
  2. deployment.md
  3. the CodeRoastServer API contract, the LogCraft scenario reference, and the cross-repo product strategy — all in unpublished CodeRoast repositories, reachable only from an internal workspace checkout

That path explains what the site renders, how the Lab talks to CodeRoastServer, what scenario YAML means, and how InSight reports are surfaced.

Cross-Project Map

Project Role Start here
CodeRoast parent docs Cross-repo product strategy, architecture, operations, compatibility, and roadmap. internal workspace only, not published
CodeRoastWeb Public website plus browser LogCraft and Insight playgrounds This folder
LogCraft Engine package and scenario DSL internal workspace only, not published
CodeRoastServer Backend API, RBAC, auth, persistence, and WebSocket snapshots internal workspace only, not published
InSight split repos Analysis packages behind the server reports consumed by the Lab insight-canon and insight-metalog are published; insight-eidos is not
logcraft-playground LogCraft Playground CLI and scenario catalog consumed by the backend ../../coderoast-hub/logcraft-playground/README.md

Maintenance Rules

  • When adding or changing a route, update architecture.md.
  • When changing API routes or WebSocket payloads, update CodeRoastServer's technical_docs/api/server_api_contract.md (unpublished repo) and this folder's architecture.md.
  • When changing VITE_API_BASE, proxy behavior, or hosting, update deployment.md.
  • When adding visible copy, update both src/i18n/en.ts and src/i18n/fr.ts, then update i18n.md if the structure changes.
  • When changing global colors, motion, or dark-mode assumptions, update theming.md.
  • Product strategy, deployment strategy, and roadmap changes belong in the internal workspace's technical_docs/, not this folder.