From de6e8a047c07c5f4b7607fc5a5e6f20e288970f7 Mon Sep 17 00:00:00 2001 From: Enrico Ros Date: Tue, 14 Oct 2025 16:26:22 -0700 Subject: [PATCH] KB: Index --- kb/KB.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 kb/KB.md diff --git a/kb/KB.md b/kb/KB.md new file mode 100644 index 000000000..a8d35e656 --- /dev/null +++ b/kb/KB.md @@ -0,0 +1,36 @@ +# Knowledge Base + +Internal documentation for Big-AGI architecture and systems, for use by AI agents and developers. + +**Structure:** +- `/kb/modules/` - Core business logic (e.g. AIX) +- `/kb/systems/` - Infrastructure (routing, startup) + +## Index + +### Modules Documentation + +#### AIX - AI Communication Framework +- **[AIX.md](modules/AIX.md)** - AIX streaming architecture documentation +- **[AIX-callers-analysis.md](modules/AIX-callers-analysis.md)** - Analysis of AIX entry points, call chains, common and different rendering, error handling, etc. +- **[AIX-adapters.md](modules/AIX-adapters.md)** - Instructions for upgrading to the latest upstream APIs + +### Systems Documentation + +#### Core Platform Systems +- **[routing-architecture.md](systems/routing-architecture.md)** - Next.js routing, provider stack, and display state hierarchy +- **[LLM-parameters-system.md](systems/LLM-parameters-system.md)** - Language model parameter flow across the system + +## Guidelines + +### Writing Style + +- **Direct and factual** - No marketing language +- **Present tense** - "AIX handles streaming" not "AIX will handle" +- **Active voice** - "The system processes" not "Processing is done by" +- **Concrete examples** - Show actual code/config when helpful, briefly + +### Maintenance + +- Remove outdated information when detected! +- Keep cross-references current when files move