Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 3.27 KB

File metadata and controls

54 lines (39 loc) · 3.27 KB

Oche documentation hub

Central index for the 501 Cloud Developer take-home. Start here before implementing or submitting.

Before you begin (read in order)

Step Document Purpose
1 HOMEWORK-SPEC.md Original company brief + technical task requirements
2 ROADMAP.md Current status, gaps summary, all enhancement tiers, sprint plan
3 checklists/01-homework-rubric.md Tick off each rubric item
4 checklists/02-pre-submission.md Manual verification + deploy
5 checklists/03-known-gaps.md Fix or explain before interview
6 checklists/04-enhancements.md Full enhancement backlog (checkboxes)

Submission one-pager: SUBMISSION.md - start here for reviewers
Interview walkthrough: INTERVIEW.md - 90 s demo + graded README talk track


Architecture & design

Doc Topic
ARCHITECTURE.md System overview
SECURITY.md Threat model + controls
RLS.md Row-level security
PERFORMANCE.md Frontend + backend perf notes
MEDIA.md Images, video, R2, transcoding
GAME-GUIDES.md How-to-play copy for each game mode
FIELD-TOOLTIPS.md Form field tooltip copy
AUTH.md JWT, API keys, RLS upgrade path
SCALE.md Rate limits, KV cache, observability
ENVIRONMENTS.md Staging vs production
DEPLOYMENT.md One-time Cloudflare setup
RELEASE.md Semver tags, changelog, npm commands
GITHUB.md Actions, Dependabot, repo hygiene
RUNBOOK.md Ops troubleshooting

ADRs (docs/adr/)

Architecture decision records - SPA vs SSR, Neon/Hyperdrive, Durable Objects, RLS, envs, styling, media, testing.

Diagrams (docs/diagrams/)

Architecture, data model, request/RLS flow, WebSocket flow, CI/CD.

Build kit

docs/PROMPTS.md - phased Cursor build prompts (reference only).

Agent rules

.cursor/rules/ - project conventions (mirrored via npm run rules:sync).