docs: enhance ARCHITECTURE.md with comprehensive pipeline documentation#29
Conversation
Expand from 1,024 to 1,441 lines with 25 Mermaid diagrams covering: - Agentic Coding Pipeline: orchestration flow, class hierarchy, agent table, state keys, task resolution (GitHub/Jira/text), streaming API spec - Agentic RAG Pipeline: full multi-agent flow with subtask loop, agent details (model/temp/tokens), Evidence model, FAISS internals, intent classification - Social Media Automation: 12-tool registry, campaign creation sequence diagram, scheduler DB schema with indexes, background service loop - Cross-Pipeline Integration: shared infra diagram, complete state key summary table across all 4 pipelines, error handling patterns Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly expands the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request significantly enhances the ARCHITECTURE.md documentation by adding detailed explanations and Mermaid diagrams for various pipelines, including the Agentic Coding, RAG, and Social Media Automation pipelines. The changes are comprehensive and greatly improve the understanding of the system's architecture. My review focuses on ensuring the consistency and accuracy of the newly added information. I've identified a few minor discrepancies in the documentation regarding agent inputs, tool counts, and data types that could be clarified.
| | `CodingAgent("gpt-coder")` | OpenAI GPT-4o | Generate/improve code | `task`, `proposed_code?` | `proposed_code` | | ||
| | `CodingAgent("claude-coder")` | Claude | Generate/improve code | `task`, `proposed_code?` | `proposed_code` | |
There was a problem hiding this comment.
The Pipeline State and State Key Summary tables correctly list a feedback key for retry loops. However, this table doesn't show feedback as an input to the CodingAgent. To improve the code on retries, the agent should receive the feedback from the failed test or QA step. Please consider updating the Input for CodingAgent to include feedback.
| | `CodingAgent("gpt-coder")` | OpenAI GPT-4o | Generate/improve code | `task`, `proposed_code?` | `proposed_code` | | |
| | `CodingAgent("claude-coder")` | Claude | Generate/improve code | `task`, `proposed_code?` | `proposed_code` | | |
| | `CodingAgent("gpt-coder")` | OpenAI GPT-4o | Generate/improve code | `task`, `proposed_code?`, `feedback?` | `proposed_code` | | |
| | `CodingAgent("claude-coder")` | Claude | Generate/improve code | `task`, `proposed_code?`, `feedback?` | `proposed_code` | |
| subgraph Agent["SocialMediaAgent"] | ||
| direction TB | ||
| EXECUTOR["AgentExecutor\n(LangChain)\nmax 10 iterations"] | ||
| PROFILE_SM["SocialMediaAgentProfile\npersona + system prompt"] | ||
| TOOL_SET["12 Tools\n(5 social + 5 content + 2 util)"] | ||
| end |
There was a problem hiding this comment.
There's a discrepancy in the number of tools for the SocialMediaAgent. The diagram here mentions 12 tools (5 social, 5 content, 2 utility), but the Tool Registry table below lists only 10 tools (5 platform/social, 5 content). The code in src/agentic_ai/agents/social_media_agent.py also seems to initialize only 10 tools. Please clarify if there are 2 missing utility tools and update the table, or if the diagram should be updated to reflect 10 tools.
| | | `status` | `PostStatus` | `draft\|scheduled\|published\|failed\|cancelled` | | ||
| | | `campaign_id` | `str` | Parent campaign reference | | ||
| | | `hashtags` | `list[str]` | Generated tags | | ||
| | | `scheduled_time` | `datetime` | When to publish | |
There was a problem hiding this comment.
The type datetime is not a native JSON type. For clarity and consistency with the API and database schema (which uses TEXT), it would be better to specify the type as string and mention the format, for example string (ISO 8601).
| | | `scheduled_time` | `datetime` | When to publish | | |
| | | `scheduled_time` | `string (ISO 8601)` | When to publish | |
Expand from 1,024 to 1,441 lines with 25 Mermaid diagrams covering: