Everything beyond the README. Start at the top and work down — the order is the path a new reader takes.
| Page | What it covers |
|---|---|
| quickstart.md | The fast path: a running platform with AWS connected |
| getting-started/ | The full guided path — prerequisites, install, AWS, Kubernetes, and your first extension |
| architecture.md | How the studio, agent, UI, xterm, and Mongo fit together, and how the hot-load loop works |
| configuration.md | Every .env variable — default, effect, and which are managed for you |
| cli-reference.md | run.sh, stop.sh, logs.sh, and every script in scripts/ — flags and behavior |
| upgrading.md | Taking framework updates, and how image-tag pinning works |
| troubleshooting.md | Symptoms, causes, fixes |
| faq.md | Licensing, data, platform support, and what happens on upgrade |
| UPGRADING-ng-common-lib.md | Refreshing the vendored @duplocloud-internal/ng-common-lib tarball |
The authoring manual is the 20 numbered guides in
.claude/skills/duplo-extension-dev/reference/ —
naming, architecture, the authoring path, base classes, hooks, custom actions, registration, scope
credentials, parent/child and menus, the SDK API, deprovisioning, enrichment and live state, current user,
forms and wizards, error handling, opt-in Ask AI sessions, the hand-written result content, access control,
and the detail-page shell. They are the source of truth, and the /duplo-extension authoring command reads
them directly.
Worked examples live in samples/ — start with
samples/helloworld, the reference sample.
| Document | What it covers |
|---|---|
| LICENSE | Apache-2.0, covering the dev-kit source |
| NOTICE | The boundary: what Apache-2.0 covers and what it does not |
| TERMS.md | The proprietary container images and vendored library — local development only |
| SECURITY.md | Reporting a vulnerability |
| PRIVACY.md | The usage metrics the UI sends, what is collected, and how to opt out |
| CONTRIBUTING.md | Framework PRs welcome; your extensions stay in your repo |
| CODE_OF_CONDUCT.md | Contributor Covenant 2.1 — expected behaviour in issues and PRs |
| SUPPORT.md | Where to get help and what to expect: GitHub Issues, best effort, no SLA |