Hub Module

Das Hub-Modul liefert die Inhalte für die Self-Documentation — Wiki-Pages, FAQs, Glossare, Knowledge-Bases. Es ist der Backbone hinter ayoune.com/de/docs/.... Routing: hub-api.ayoune.app.

Hauptentitäten

KnowledgeBases

Eine KB ist ein Buch — sie bündelt zusammengehörige WikiPages.

Feld	Hinweis
`slug`	URL-Pfad-Segment, z.B. `developer-portal`
`title`	Display
`description`	1-2 Zeilen
`theme`	Farb-Schema (`indigo`, `emerald`, `amber`, ...)
`icon`	Material-Icon
`published`	bool
`order`	Sortierung in Hub-Sidebar

Beispiel-KBs (siehe kbSeeder.ts INITIAL_KBS):

Slug	Theme	Icon
cli	slate	terminal
developer-portal	indigo	code
admin-handbook	emerald	shield
self-hosting	amber	server
api-reference	teal	plug
release-notes	violet	calendar

WikiPages

Einzelne Markdown-Seiten innerhalb einer KB.

Feld	Hinweis
`kbslug`	KB-Zugehörigkeit (auch im Frontmatter erlaubt)
`slug`	unique pro KB
`parentSlug`	Hierarchie (optional)
`order`	Sort within Parent (10er-Schritten)
`title`	H1
`locale`	`de`, `en`, ...
`contentFormat`	`markdown` / `html`
`body`	Roh-Inhalt
`bodyHtml`	Gerendert (von `worker-content-modifications`)
`tags`	string[]
`published`	bool

FAQs

Q&A-Format. Enger als WikiPages — gedacht für Schnellinfos.

slug: how-do-i-reset-password
question: "Wie setze ich mein Passwort zurück?"
answer: "Auf der Login-Seite ..."
category: account

Glossaries

Glossar-Einträge, die im Wiki-Render automatisch verlinkt werden (siehe linkGlossaryTerms im Render-Worker).

Feld	Hinweis
`term`	"AY Singleton"
`definition`	Markdown
`aliases`	["AY", "ay-instance"]

Routen

GET  /knowledgebases
GET  /knowledgebases/:slug
GET  /wikipages
GET  /wikipages?kbslug=developer-portal
GET  /wikipages/:id
POST /wikipages
PATCH /wikipages/:id
POST /wikipages/:id/actions/publish
POST /wikipages/:id/actions/translate

GET  /faqs
GET  /glossaries

Suche

Hub nutzt Atlas-Search (siehe Self-Hosting → Kubernetes). Index: hub_search über wikipages + faqs + glossaries.

GET /search?q=auth+jwt&kbslug=developer-portal

Antwort enthält Highlights, Score und Cross-Refs.

Render-Pipeline

Wenn eine WikiPage gespeichert wird, läuft worker-content-modifications:

Markdown → HTML
Sanitize (XSS-Schutz)
Glossar-Linking
Mermaid → SVG
TOC-Generation
Cross-Link-Auflösung (wiki:<kb>/<slug> → URL)
Hash-Check (Idempotenz)
bodyHtml aktualisiert
Pub/Sub wikipage.rendered → consumer-app invalidiert Cache

CLI-Workflow

ay create wikipages "Mein Beitrag" \
  --set kbslug=developer-portal \
  --set slug=mein-beitrag \
  --set body="# Hi" \
  --set published=true

ay exec hub:seed --file ./tooling/cli/docs/pages/de/...   # Bulk-Import

Der Seeder liest kbslug aus dem Frontmatter — sonst zweites Pfad-Segment, sofern in der Whitelist (developer-portal | admin-handbook | self-hosting | api-reference | release-notes).

Verbindungen

CMS-Module — public-facing Pages (anders gerendert)
Self-Hosting — Atlas-Search-Setup

Mit dieser Seite weiterarbeiten

Fertige Anweisungen für dein KI-Werkzeug. Kopieren, einfügen, loslegen — die KI holt sich den Inhalt selbst über die Adresse im Text.

Die Schritte für mich zusammenfassen Das Wesentliche, in der richtigen Reihenfolge.

In ChatGPT öffnen

Lies die folgende Dokumentation von tolinax UG und arbeite damit.

Diese Seite: https://ayoune.com/de/docs/api-reference/hub-module.md
Die vollständige Sammlung: https://ayoune.com/de/docs/api-reference.md

Fasse den Inhalt für mich zusammen.

- Zuerst in zwei Sätzen: worum geht es hier?
- Dann die Schritte in der Reihenfolge, in der ich sie gehen muss.
- Je Schritt eine Zeile, in einfacher Sprache.
- Am Ende: was ich vorher bereithalten sollte.

Lass nichts weg, was ich brauche, um wirklich fertig zu werden.
Hinweis zu den Quellen:
- Jede Seite dieser Dokumentation ist als Markdown abrufbar (dieselbe Adresse mit `.md`).
- Ein maschinenlesbarer Überblick aller öffentlichen Inhalte liegt unter `/llms.txt`.
- Falls du Zugriff auf den aYOUne-MCP-Server hast, kannst du damit gegen lebende Daten
  arbeiten statt gegen diese Momentaufnahme. Falls nicht, ignoriere diesen Punkt.

Bei der Einrichtung helfen Schritt für Schritt, mit Rückfragen an mich.

In ChatGPT öffnen

Lies die folgende Dokumentation von tolinax UG und arbeite damit.

Diese Seite: https://ayoune.com/de/docs/api-reference/hub-module.md
Die vollständige Sammlung: https://ayoune.com/de/docs/api-reference.md

Begleite mich Schritt für Schritt durch die Einrichtung.

- Sag mir zuerst, was ich bereithalten muss (Zugänge, Daten, Zeit).
- Dann führe mich EINEN Schritt nach dem anderen. Warte auf mein "weiter".
- Nenne je Schritt, woran ich merke, dass er geklappt hat.
- Wenn etwas schiefgeht, frag nach der genauen Meldung, statt zu raten.

Wenn die Anleitung eine Stelle offen lässt, sag mir das, statt sie zu erfinden.
Hinweis zu den Quellen:
- Jede Seite dieser Dokumentation ist als Markdown abrufbar (dieselbe Adresse mit `.md`).
- Ein maschinenlesbarer Überblick aller öffentlichen Inhalte liegt unter `/llms.txt`.
- Falls du Zugriff auf den aYOUne-MCP-Server hast, kannst du damit gegen lebende Daten
  arbeiten statt gegen diese Momentaufnahme. Falls nicht, ignoriere diesen Punkt.

Bei einem Problem weiterhelfen Ursache eingrenzen statt raten.

In ChatGPT öffnen

Lies die folgende Dokumentation von tolinax UG und arbeite damit.

Diese Seite: https://ayoune.com/de/docs/api-reference/hub-module.md
Die vollständige Sammlung: https://ayoune.com/de/docs/api-reference.md

Hilf mir, ein Problem einzugrenzen.

- Frag mich zuerst, was ich beobachte und was ich erwartet hätte.
- Leite daraus die wahrscheinlichsten Ursachen ab, die zu dieser Quelle passen.
- Gib mir je Ursache EINEN Test, der sie bestätigt oder ausschließt.
- Sortiere so, dass der billigste Test zuerst kommt.

Rate nicht. Wenn die Quelle das Problem nicht abdeckt, sag mir, wo ich
weitersuchen sollte.
Hinweis zu den Quellen:
- Jede Seite dieser Dokumentation ist als Markdown abrufbar (dieselbe Adresse mit `.md`).
- Ein maschinenlesbarer Überblick aller öffentlichen Inhalte liegt unter `/llms.txt`.
- Falls du Zugriff auf den aYOUne-MCP-Server hast, kannst du damit gegen lebende Daten
  arbeiten statt gegen diese Momentaufnahme. Falls nicht, ignoriere diesen Punkt.

In einfachen Worten erklären Ohne Fachbegriffe, von Grund auf.

In ChatGPT öffnen

Lies die folgende Dokumentation von tolinax UG und arbeite damit.

Diese Seite: https://ayoune.com/de/docs/api-reference/hub-module.md
Die vollständige Sammlung: https://ayoune.com/de/docs/api-reference.md

Erkläre den Inhalt so, dass ihn jemand ohne Vorwissen versteht.

- Beginne mit dem Zweck: wozu gibt es das überhaupt?
- Fachbegriffe beim ersten Vorkommen in einem Halbsatz erklären.
- Ein Alltags-Vergleich, wo er wirklich trägt — keiner, wo er hinkt.
- Am Ende: die drei Dinge, die man sich merken sollte.

Kürze nicht durch Weglassen von Einschränkungen. Eine Vereinfachung, die eine
Bedingung unterschlägt, ist eine Falschaussage.
Hinweis zu den Quellen:
- Jede Seite dieser Dokumentation ist als Markdown abrufbar (dieselbe Adresse mit `.md`).
- Ein maschinenlesbarer Überblick aller öffentlichen Inhalte liegt unter `/llms.txt`.
- Falls du Zugriff auf den aYOUne-MCP-Server hast, kannst du damit gegen lebende Daten
  arbeiten statt gegen diese Momentaufnahme. Falls nicht, ignoriere diesen Punkt.

Checkliste zum Abhaken Zum Mitgehen während der Umsetzung.

In ChatGPT öffnen

Lies die folgende Dokumentation von tolinax UG und arbeite damit.

Diese Seite: https://ayoune.com/de/docs/api-reference/hub-module.md
Die vollständige Sammlung: https://ayoune.com/de/docs/api-reference.md

Mache daraus eine **abhakbare Checkliste** für die praktische Umsetzung.

- Je Punkt genau eine Handlung, im Imperativ.
- Reihenfolge so, dass kein Punkt eine spätere Voraussetzung braucht.
- Voraussetzungen und Stolperstellen als eingerückte Unterpunkte.
- Am Ende eine Abnahme: woran erkenne ich, dass alles richtig ist?
Hinweis zu den Quellen:
- Jede Seite dieser Dokumentation ist als Markdown abrufbar (dieselbe Adresse mit `.md`).
- Ein maschinenlesbarer Überblick aller öffentlichen Inhalte liegt unter `/llms.txt`.
- Falls du Zugriff auf den aYOUne-MCP-Server hast, kannst du damit gegen lebende Daten
  arbeiten statt gegen diese Momentaufnahme. Falls nicht, ignoriere diesen Punkt.

In mein Projekt einbauen Konkreter Code für meinen Anwendungsfall.

In ChatGPT öffnen

Lies die folgende Dokumentation von tolinax UG und arbeite damit.

Diese Seite: https://ayoune.com/de/docs/api-reference/hub-module.md
Die vollständige Sammlung: https://ayoune.com/de/docs/api-reference.md

Hilf mir, das in mein Projekt einzubauen.

- Frag mich zuerst nach Sprache, Umgebung und dem, was ich erreichen will.
- Gib dann ein minimales, lauffähiges Beispiel — keine Auslassungs-Punkte.
- Benenne die Fehlerfälle, die ich abfangen muss, und wie sie sich zeigen.
- Nenne Grenzen: Zeitlimits, Mengenbegrenzungen, Berechtigungen.

Verwende ausschließlich das, was die Quelle wirklich beschreibt. Erfinde keine
Felder, Parameter oder Endpunkte — ein erfundener Aufruf kostet mich mehr Zeit,
als er spart.
Hinweis zu den Quellen:
- Jede Seite dieser Dokumentation ist als Markdown abrufbar (dieselbe Adresse mit `.md`).
- Ein maschinenlesbarer Überblick aller öffentlichen Inhalte liegt unter `/llms.txt`.
- Falls du Zugriff auf den aYOUne-MCP-Server hast, kannst du damit gegen lebende Daten
  arbeiten statt gegen diese Momentaufnahme. Falls nicht, ignoriere diesen Punkt.

War dieser Artikel hilfreich?

👎 Nein (0)

Kommentar hinterlassen