Wake documentation
Where to find what, and how the documentation is organised.
The documentation is split by what you want to do, following the Diátaxis framework:
| Section | Read it when you … |
|---|---|
| Getting started | want a site running for the first time |
| Guides | have a concrete task, e.g. "add a second language" |
| Reference | need the exact name of a setting, field or command |
| Concepts | want to understand how and why Wake works the way it does |
| Decisions | wonder why something was decided, and what was rejected |
| Contributing | want to improve Wake or these pages |
Getting started
- System requirements
- Installation on your computer
- Install on a web host
- Your first site: a walk through the panel
- Updating
Guides
Writing and organising: Write and publish · Arrange pages and menus · Categories and events · Add a second language · Move from Ghost
Running the site: Invite your team · Sign in with two factors · Back up and restore · Connect an AI assistant
Look and extensions: Choose and adjust a theme · Build a theme · Write a plugin
Reference
- Configuration: every setting in
settings/config.php - Content format: folders, files, front matter, menus
- Templates: what a theme can use
- Tide: the default theme
- Plugins: what a plugin can add
- MCP server: tools for AI assistants
- Command line: Artisan commands
- Roles: who may do what
- Content API: content as JSON
Concepts
Project
About these pages
Every page is a Markdown file with front matter, in exactly the format Wake uses for its own content. The documentation website will be a Wake site that reads this folder.
source: docs/README.md