Docs Map
Use this page as the route map. The docs are intentionally small: each page should answer a busy developer’s next question without sending them through a chain of fragments.
Start Here
Section titled “Start Here”| Job | Read |
|---|---|
| Try Capell quickly | Quickstart |
| Pick the right install path | Install matrix |
| Explain Capell without code | Why Capell |
| Deep-dive the developer architecture | How Capell works |
| See interactive page experiences | Capell Interactions |
| Build with Inertia | Capell Inertia runtime |
| Understand the AI-ready path | AI-ready Capell |
| See durable upgrade operations | Durable Upgrade Operations |
| Learn the core concepts in order | Capell Learn |
| Install it in a real Laravel app | Install guide |
| Use the admin panel | Admin |
| Work on public rendering | Frontend |
| Manage themes end to end | Theme Library |
| Build a custom theme package | Creating custom themes |
| Build or maintain an extension | Packages |
| Scaffold a package | Package authoring |
| Build an extension from scratch | Build an extension end to end |
| Decide where a feature belongs | Host, package, or app code |
| Work in this repo | Development |
| Debug production behavior | Operations |
| See a realistic content model | Music store CMS example |
Featured Build Path
Section titled “Featured Build Path”| Widget | Start | Continue | Extension page |
|---|---|---|---|
| Build Inertia with Capell | Capell Inertia runtime | Inertia widgets and Bookings | Packages and extensions |
Visual Tour
Section titled “Visual Tour”Use these pages when you need to see the product before reading architecture detail:
| Screen or flow | Start with | What to look for |
|---|---|---|
| Admin workspace | Admin interface | Dashboard, Pages, Media, Settings, Theme Library, and Site Health screenshots. |
| First page authoring | Create your first page | Site and parent selection, URL preview, content editor, draft actions, settings. |
| Theme management | Theme Library | Installed themes, available themes, diagnostics, customize, preview, and apply. |
| Operations diagnostics | Site Health | Cache status, public-output safety, static generation, optimizer, server checks. |
| Real content model | Music store CMS example | How pages, articles, events, products, artists, and navigation fit together. |
Main Docs
Section titled “Main Docs”| Page | Covers |
|---|---|
| Admin | Filament resources, settings, users, media, recovery shell, dashboard Filament widgets, admin extension points. |
| Frontend | Site/page resolution, public HTML safety, media output, render hooks, Tailwind assets, server rules, frontend tests. |
| Packages | Package shape, manifests, service providers, extension points, Actions/Data/settings, admin/frontend contributions, migrations, tests. |
| Performance | Page cache, fragment cache, model URL cache, ETags, critical assets, lazy hydration. |
| Platform features | Package authoring and durable upgrade operations for Capell platform capabilities. |
| Operations | Site Health, Lockdown, upgrades, Marketplace connection, install/admin/frontend troubleshooting. |
| Development | Local repo shape, commands, configuration, seeders, diagnostics, settings migrations. |
| Reference | Glossary, relationship maps, credits, and package boundary references. |
Common Decisions
Section titled “Common Decisions”| Question | Read |
|---|---|
| Which install path should I use? | Install matrix |
| Does this belong in the host repo, a package, or an app? | Host, package, or app code |
| Which extension point should a package use? | Extension point chooser |
| How should I scaffold a package? | Package authoring |
| What exact contract/tag/test should I use? | Extension point API reference |
| Why is my package contribution missing? | Extension troubleshooting |
| What can public HTML expose? | Public HTML safety contract |
| How do themes reach the frontend? | Frontend themes |
| How do I create a theme package? | Creating custom themes |
| How do lazy widgets and fragments work? | Capell Interactions |
| Which patterns are forbidden? | Do not do this |
| Where should a new doc go? | Docs ownership rules |
URL Preservation
Section titled “URL Preservation”Treat published URLs as durable. When replacing, moving, or rebuilding an old page, keep the new page clean and preserve the old address with a Page URL whose type is Redirect. The redirect record owns the legacy source path and points it at the current page URL, so visitors, bookmarks, inbound links, and search engines still reach the right content without keeping a duplicate page around.
Capell also creates automatic redirect Page URLs when a published page URL changes because a slug or parent path changed. Add a manual redirect when you are creating a new page to replace an existing URL, consolidating old content, or importing legacy routes from another CMS.
For the detailed model, read Page management: URL history and redirects.
Host Packages
Section titled “Host Packages”| Package | Composer name | Package doc |
|---|---|---|
| Core | capell-app/core | Core overview |
| Admin | capell-app/admin | Admin overview |
| Frontend | capell-app/frontend | Frontend overview |
| Installer | capell-app/installer | Installer overview |
| Marketplace | capell-app/marketplace | Marketplace overview |
First-party add-ons are documented by their generated extension pages and package-owned READMEs. Use Packages and extensions for host package boundaries and authoring entry points.
Rules For New Docs
Section titled “Rules For New Docs”- Update an existing page before adding a new file.
- Link every new doc from this page, a section index, a package overview, or another doc.
- Put historical plans outside the public docs tree.
- Do not keep “moved” stubs unless a published URL needs a temporary redirect.
- Keep extension-point examples beside the reader task that needs them.
- Do not document optional packages as built-in host behavior.
- Public frontend docs must preserve the safety rule: anonymous HTML must not expose authoring controls, model IDs, selectors, signed editor URLs, or package internals.