Zum Inhalt springen

Documentation as Code

Documentation as Code

Wie ADDXION® Dokumentation strukturiert und gepflegt wird.

Dokumentation lebt als Markdown/MDX im Repo addxion-docs und wird unter addxion.com/docs/ ausgeliefert. Marketing und CMS bleiben in addxion-com.

Content-OrdnerURL
src/content/docs//docs/
src/content/docs/ecosystem//docs/ecosystem/
src/content/docs/neon//docs/neon/
src/content/docs/ai//docs/ai/
src/content/docs/patterns//docs/patterns/
src/content/docs/branding//docs/branding/
src/content/docs/{xi,shell,behavior}//docs/{block}/

Die Navigation wird in astro.config.mjs definiert. Unterverzeichnisse können per autogenerate eingebunden werden.

DateiRepoZweck
public/llms.txtaddxion-comMarketing-Index mit Links
public/llms-full.txtaddxion-comVolltext nur Marketing-Seiten
public/llms.txtaddxion-docsPlattform-Docs-Index

Bei neuer Plattform-Doc: addxion-docs Content + llms.txt dort. Bei neuer Marketing-Seite: addxion-com llms.txt und ggf. llms-full.txt.

Siehe auch Websites entwickeln.

  • Produktname: Neon, AI
  • Docs auf Deutsch (wie Marketing)
  • Code-Beispiele aus echten Repos, nicht abstrahiert

Truths sind SSOT — auch für sich selbst. Kanonische Wahrheiten nur in Truths. Jede andere Doc-Seite listet am Ende ## Truths (IDs) und ## Für Agents (Handlung). Consumer-Repos: ## Truths in AGENTS.md.

WasWo
Volltext einer Truthecosystem/truths.md
Relevante Truths pro Seite## Truths am Seitenende
Handlungsregeln für Agents## Für Agents direkt darunter

Jede Doc-Seite trägt am Ende zuerst ## Truths, dann ## Für Agents. Truths sind festgehaltene Wahrheiten; ## Für Agents enthält Handlungsregeln für Coding-Agents.

Alle Plattform-Truths leben zentral in Truths — Plattform-Wahrheiten. Doc-Seiten listen nur relevante Truth-IDs — keinen Volltext.

Meta-Truth T-TRUTHS-SSOT: Die Truth-Registry ist selbst SSOT — auch das Prinzip „Truths überall referenzieren“ ist eine Truth.

## Truths
| ID | Wahrheit |
|----|----------|
| [T-DOC-SECTIONS](/docs/ecosystem/truths/#t-doc-sections) | Jede Doc-Seite: ## Truths + ## Für Agents |
| [T-TRUTHS-SSOT](/docs/ecosystem/truths/#t-truths-ssot) | Truths-Registry — referenzieren, nicht duplizieren |
| [T-PLATFORM-SSOT](/docs/ecosystem/truths/#t-platform-ssot) | Plattform-Wahrheit nur in addxion-docs |
## Für Agents
**Scope:** Wie ADDXION-Dokumentation strukturiert und gepflegt wird.
- Jede Doc-Seite endet mit `## Für Agents` (diese Konvention)
- Neue Seite: Frontmatter `title` + `description`, Agent-Sektion nicht vergessen
- Plattform-Docs nur in addxion-docs; `bun run build` vor Merge