SCALR Documentation

Welcome to the SCALR internal documentation.

What this is

SCALR is a single monorepo containing every piece of code at the company: the marketing website, the login portal, the application hub, internal tools, subscription products, and per-client work. They all share authentication, design, and conventions.

Where to start

If you're new to the codebase, read these in order:

1. Architecture Overview — the big picture.
2. Adding a New App — the most common task.
3. app.manifest.yml reference — the contract every app declares.

If you're picking up active development, read:

• The repo's PLAN.md for what's not yet built.
• Open Questions for decisions still on the table.
• The ADRs for context on past decisions.

If you're an AI agent creating a new app:

• Start at Creating an App with AI.
• Then read template-app/AGENT_INSTRUCTIONS.md in the repo.

Conventions

• ADRs are immutable. Once written, they capture a moment in time. New decisions get new ADRs; they don't edit old ones.
• Open questions become ADRs when settled.
• The current state lives here in architecture/ and reference/. Keep it accurate.