Slim down README: features to a blog post, docs pointer, ASCII banner

Features section becomes a "Novaconium Features" blog post
(App/pages/blog/novaconium-features/), demonstrating the framework's own
content model rather than living as a long bullet list in README.md.
Getting started is trimmed to the minimum needed to run the site and
reach /admin/docs, which is now the single canonical source for every
topic (Docker, deploying, project layout, etc.) instead of being
mirrored into README.md. Third-party section kept as-is. AGENTS.md's
documentation-duplication rule updated to describe this new split so
future changes don't re-bloat the README. Also adds an ASCII art banner
above the title.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
code
2026-07-15 07:44:51 +00:00
parent a0ae58c29e
commit c0455241ea
4 changed files with 88 additions and 119 deletions
+19 -8
View File
@@ -12,19 +12,30 @@ query the graph instead of expecting this file to carry that context — this
file is kept intentionally short and only lists things that will cause a
bug or a broken convention if you don't know them going in.
## Documentation is duplicated on purpose — keep all copies in sync
## Docs live in one place: `/admin/docs` — README stays thin
Every topic (routing, sidecars, libraries, layouts, caching, SEO, Matomo,
admin auth, styling, Docker, project layout, third-party) exists in two
places: a page under `novaconium/pages/admin/docs/<topic>/index.twig`
(canonical) and a mention in `README.md`. Any change to framework behavior
or a new feature must update both in the same change:
admin auth, styling, Docker, project layout, third-party) has exactly one
canonical writeup: a page under `novaconium/pages/admin/docs/<topic>/index.twig`.
`README.md` deliberately does **not** mirror this content — it's a short
GitHub-facing pitch (what this is, minimal steps to get it running, a
pointer into `/admin/docs`) plus the Third-party section, nothing more. The
full feature list lives as a blog post, `App/pages/blog/novaconium-features/`
(sample content, replaceable like any other post), not in the README. This
was a deliberate change (2026-07-15) away from an earlier "keep README and
docs in sync" convention that had made the README long and hard to scan —
don't re-add a feature list or per-topic bullet list to README.md.
Any change to framework behavior or a new feature:
1. Update/add the docs page, and if new, link it from both
`admin/docs/index.twig` and the nav in `admin/docs/_layout/layout.twig`.
2. Update `README.md` if it affects the feature list, getting-started
steps, or the docs index there.
3. Update this file only if it affects a convention an agent needs to know
2. Update `App/pages/blog/novaconium-features/index.twig` (and its entry in
`App/pages/blog/index.php`) if it affects the feature tour.
3. Update `README.md` only if it affects the one-paragraph pitch, the
minimal getting-started steps, or the Third-party section — not a
per-feature bullet.
4. Update this file only if it affects a convention an agent needs to know
before editing code.
## What this is