Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

ITL.BrainCell Documentation

API

File Description
api/ARCHITECTURE.md System architecture — services, ports, modules, data flow, Weaviate schema
api/ENDPOINTS.md Full REST API reference with request/response examples

Deployment

File Description
deployment/DOCKER.md Local development with docker compose — ports, env vars, troubleshooting
deployment/KIND.md Helm chart testing with a local Kind cluster
deployment/KUBERNETES.md Production deployment — Helm install, secrets, scaling, rollback

MCP (Model Context Protocol)

File Description
mcp/GUIDE.md MCP server overview, tools reference, configuration
mcp/QUICK_REFERENCE.md One-page MCP cheat sheet
mcp/INTEGRATION.md Agent integration examples — Claude, Python, Azure AI

Guides

File Description
guides/QUICK_START.md Five-minute setup from clone to running
guides/DATABASE.md Schema reference, seed data, migrations, common DB operations

Testing

File Description
testing/TESTING.md Running tests, test categories, manual API and MCP curl examples

Roadmap

File Description
roadmap/README.md Roadmap overview — immediate backlog + completed auto-detection
roadmap/PLANNED_CELLS.md New cells: tasks, references, errors, persons, versions
roadmap/INTELLIGENCE.md Cross-cell linking, duplicate detection, session context injection, weekly digest
roadmap/INTEGRATIONS.md GitHub, Jira/Azure DevOps, Slack/Teams, Keycloak per-user memory
roadmap/ADVANCED.md Contradictie-detectie, kennisgraaf, proactieve context push, multi-agent geheugen, fine-tuning export

Where to start

New to the project? Start with the Quick Start Guide.

Deploying? See Docker for local or Kubernetes for production.

Integrating with Copilot or Claude? See the MCP Guide and Integration Examples.

API development? See Endpoints and Architecture.

Running tests? See the Testing Guide.


Documentation Structure

docs/
├── api/          ARCHITECTURE.md, ENDPOINTS.md
├── deployment/   DOCKER.md, KIND.md, KUBERNETES.md
├── guides/       QUICK_START.md, DATABASE.md
├── mcp/          GUIDE.md, QUICK_REFERENCE.md, INTEGRATION.md
├── testing/      TESTING.md
└── README.md