On this page 2 entries
The docs files
Every template comes with a set of documentation files at its root. Each is written for one reader; AI reads AGENTS.md first.
The files
| File | What it covers | For |
|---|---|---|
README.md | Overview, running it locally, going live | Everyone |
HUONG-DAN-SU-DUNG.md | The site’s pages, editing in the admin, everyday tasks, SEO and trackers, troubleshooting (in Vietnamese) | Site owners, writers |
FEATURES.md | What the site does, doesn’t do, or does in part | Site owners, developers |
DEPLOY.md | Build commands, environment variables, what isn’t ready, the go-live checklist | Developers |
PRODUCT.md | The business behind the site: brand, customers, offering, policies | Site owners, writers, AI |
DESIGN.md | Colours, fonts, spacing, interface rules (machine-readable: .impeccable/design.json) | Designers, developers, AI |
CONTEXT.md | Current state, open decisions, known gaps | Developers, AI |
CREDITS.md | Source and licence of images, fonts, icons and third-party code | Site owners, developers |
AGENTS.md | How to work in the code: structure, commands, conventions | Developers, AI |
CLAUDE.md | Only points to AGENTS.md, so Claude Code reads it | AI |
Keep the docs true to the code
Adding or removing a feature updates FEATURES.md in the same commit; a new third-party image or font goes into CREDITS.md; an open decision goes into CONTEXT.md. AI can do this for you (see 4 Working with AI).
Warning
Before going live, every image and asset in CREDITS.md must be marked usable. Replace any that are not.