Skip to content

Docs: add internal documentation directory to main README #54

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alinarojas merged 1 commit into from
May 5, 2026
Merged

Docs: add internal documentation directory to main README #54

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,20 @@ The system is orchestrated by a **Semantic Router** that classifies user intent

---

## Internal Documentation

For deep dives into specific modules, architecture components and implementation details, please refer to our dedicated internal documentation:

* **[Agents & Factory Architecture](./app/src/agents/README.md)**: Detailed breakdown of the agentic ecosystem, including the Base Agent, Factory Agent and the specific implementations (Calendar, Chat, CRM, Finance).
* **[Semantic Router](./app/src/services/README.md)**: Guide on the intent classification engine that evaluates user inputs and dispatches tasks to the correct agent.
* **[MCP Server & Tools](./app/src/mcp_Server/README.md)**: Documentation covering the Model Context Protocol (MCP) integration and the comprehensive suite of tools connecting the AI to Odoo.
* **[Guardrails & Safety](./app/src/guardrails/README.md)**: Information on how Guardrails AI enforces structured outputs, prevents hallucinations and ensures safe execution.
* **[Traceability & Observability](./app/src/traceability/README.md)**: Setup and usage instructions for tracking system state, telemetry and debugging using Pydantic Logfire.
* **[Gmail Polling Service](./app/src/polling/README.md)**: Overview of the background worker responsible for polling and ingesting incoming emails into the pipeline.
* **[Testing Strategy](./app/tests/README.md)**: Guidelines on our testing protocols, test structure and mocking strategies to maintain high coverage.

---

## Key Features

* **MCP Integration**: Uses the *Model Context Protocol* via **FastMCP** to connect AI tools directly with the Odoo backend.
Expand Down Expand Up @@ -60,7 +74,7 @@ docker network create perry-network
### 2. Odoo Setup (`testing-odoo`)
Clone and launch the Odoo instance:
```bash
git clone https://github.com/your-user/testing-odoo.git
git clone https://github.com/Perry-Multi-LLM/testing-odoo.git
cd testing-odoo
docker-compose up -d --build
```
Expand All @@ -69,7 +83,7 @@ docker-compose up -d --build
Clone the orchestrator and configure the environment:
```bash
cd ..
git clone https://github.com/your-user/ingest-api.git
git clone https://github.com/Perry-Multi-LLM/ingest-api.git
cd ingest-api
```
Create a `.env` file following the `.env-example` template, then launch:
Expand Down
Loading