Docs: add internal documentation directory to main README#54
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates the root
README.mdto serve as a centralized hub for all internal documentation across the system architecture.By mapping out the sub-module guides, it significantly improves developer onboarding and repository navigability.
Changes included
README.mdfiles across the codebase.agents: Factory and specialized agents (Calendar, Chat, CRM, Finance).services: Semantic Router implementation.mcp_Server: FastMCP protocol and Odoo tools.guardrails: AI safety and output validation.traceability: Pydantic Logfire observability stack.polling: Background worker for Gmail ingestion.tests: Testing strategy and coverage standards.Closes #50