Overview

This issue tracks the comprehensive review of all documentation files defined in docs/docs.json. Each document must be reviewed for:

• Accuracy - Technical content is correct and up-to-date
• Completeness - All necessary information is included
• Clarity - Content is clear and well-organized
• Links - Internal/external links are valid
• Code Examples - Code snippets are correct and runnable
• Consistency - Follows documentation style guide

---

Review Legend

Symbol	Meaning
⬜	Not started
🔄	In progress
✅	Approved
❌	Needs revision
🔍	Under review

---

Tab 1: Documentation

Getting Started

Status	Document	Path	Reviewer	Notes
✅	Welcome / Index	index.mdx	@kovtcharov-amd
✅	Setup Guide	setup.mdx	@kovtcharov-amd
✅	Quickstart	quickstart.mdx	@kovtcharov-amd

User Guides

Status	Document	Path	Reviewer	Notes
⬜	Guides Index	guides/index.mdx
✅	Hardware Advisor	guides/hardware-advisor.mdx	@eddierichter-amd
✅	Chat Guide	guides/chat.mdx	@itomek	gaia talk fails with no module named pip
⬜	Talk Guide	guides/talk.mdx		gaia talk fails with no module named pip
✅	Code Guide	guides/code.mdx	@eddierichter-amd
🔄	EMR Guide	guides/emr.mdx	@kovtcharov-amd
✅	Blender Guide	guides/blender.mdx	@itomek
⬜	Jira Guide	guides/jira.mdx
⬜	Docker Guide	guides/docker.mdx
⬜	Routing Guide	guides/routing.mdx

Playbooks

Playbooks Overview

Status	Document	Path	Reviewer	Notes
⬜	Playbooks Index	playbooks/index.mdx

Hardware Advisor Agent Playbook

Status	Document	Path	Reviewer	Notes
✅	Part 1: Getting Started	playbooks/hardware-advisor/part-1-getting-started.mdx	@eddierichter-amd

Document Q&A Agent Playbook

Status	Document	Path	Reviewer	Notes
✅	Part 1: Getting Started	playbooks/chat-agent/part-1-getting-started.mdx	@eddierichter-amd
✅	Part 2: Advanced Features	playbooks/chat-agent/part-2-advanced-features.mdx	@eddierichter-amd
✅	Part 3: Deployment	playbooks/chat-agent/part-3-deployment.mdx	@eddierichter-amd

Code Generation Agent Playbook

Status	Document	Path	Reviewer	Notes
⬜	Part 1: Introduction	playbooks/code-agent/part-1-introduction.mdx
⬜	Part 2: App Creation	playbooks/code-agent/part-2-app-creation.mdx
⬜	Part 3: Validation & Building	playbooks/code-agent/part-3-validation-building.mdx

Medical Intake Agent Playbook

Status	Document	Path	Reviewer	Notes
🔄	Part 1: Getting Started	playbooks/emr-agent/part-1-getting-started.mdx	@kovtcharov-amd
🔄	Part 2: Dashboard	playbooks/emr-agent/part-2-dashboard.mdx	@kovtcharov-amd
🔄	Part 3: Architecture	playbooks/emr-agent/part-3-architecture.mdx	@kovtcharov-amd

SDK Reference

SDK Overview

Status	Document	Path	Reviewer	Notes
⬜	SDK Index	sdk/index.mdx

Core Concepts

Status	Document	Path	Reviewer	Notes
⬜	Agent System	sdk/core/agent-system.mdx
⬜	Tools	sdk/core/tools.mdx
⬜	Console	sdk/core/console.mdx

SDKs

Status	Document	Path	Reviewer	Notes
⬜	Chat SDK	sdk/sdks/chat.mdx
⬜	RAG SDK	sdk/sdks/rag.mdx
⬜	LLM SDK	sdk/sdks/llm.mdx
⬜	VLM SDK	sdk/sdks/vlm.mdx
⬜	Audio SDK	sdk/sdks/audio.mdx

Infrastructure

Status	Document	Path	Reviewer	Notes
⬜	API Server	sdk/infrastructure/api-server.mdx
⬜	MCP	sdk/infrastructure/mcp.mdx

Mixins & Utilities

Status	Document	Path	Reviewer	Notes
⬜	Tool Mixins	sdk/mixins/tool-mixins.mdx
⬜	Code Mixins	sdk/mixins/code-mixins.mdx
⬜	File Watcher	sdk/utils/file-watcher.mdx

Agents

Status	Document	Path	Reviewer	Notes
⬜	Talk Agent	sdk/agents/talk.mdx
⬜	Routing Agent	sdk/agents/routing.mdx
⬜	Specialized Agents	sdk/agents/specialized.mdx

SDK Guides

Status	Document	Path	Reviewer	Notes
⬜	Packaging	sdk/packaging.mdx
⬜	Applications	sdk/applications.mdx
⬜	Configuration	sdk/configuration.mdx
⬜	Testing	sdk/testing.mdx
⬜	Security	sdk/security.mdx
⬜	Best Practices	sdk/best-practices.mdx

Resources

Status	Document	Path	Reviewer	Notes
⬜	Examples	sdk/examples.mdx
⬜	Advanced Patterns	sdk/advanced-patterns.mdx
⬜	API Reference	sdk/api-reference.mdx
⬜	Migration	sdk/migration.mdx
⬜	Troubleshooting	sdk/troubleshooting.mdx

---

Tab 2: Specifications

Core Framework

Status	Document	Path	Reviewer	Notes
⬜	Agent Base	spec/agent-base.mdx
⬜	Tool Decorator	spec/tool-decorator.mdx
⬜	Console	spec/console.mdx
⬜	File Change Handler	spec/file-change-handler.mdx

SDKs

Status	Document	Path	Reviewer	Notes
⬜	Chat SDK Spec	spec/chat-sdk.mdx
⬜	RAG SDK Spec	spec/rag-sdk.mdx
⬜	Talk SDK Spec	spec/talk-sdk.mdx
⬜	LLM Client Spec	spec/llm-client.mdx
⬜	VLM Client Spec	spec/vlm-client.mdx
⬜	Audio Client Spec	spec/audio-client.mdx

Infrastructure

Status	Document	Path	Reviewer	Notes
⬜	Plugin Registry	spec/plugin-registry.mdx
⬜	Routing Agent	spec/routing-agent.mdx
⬜	Test Utilities	spec/test-utilities.mdx
⬜	API Agent	spec/api-agent.mdx
⬜	MCP Agent	spec/mcp-agent.mdx
⬜	API Server	spec/api-server.mdx
⬜	MCP Server	spec/mcp-server.mdx

Code Infrastructure

Status	Document	Path	Reviewer	Notes
⬜	Code Models	spec/code-models.mdx
⬜	Orchestrator	spec/orchestrator.mdx
⬜	Validators	spec/validators.mdx
⬜	Prompts	spec/prompts.mdx

Tool Mixins

Status	Document	Path	Reviewer	Notes
⬜	Database Mixin	spec/database-mixin.mdx
⬜	CLI Tools Mixin	spec/cli-tools-mixin.mdx
⬜	Code Tools Mixin	spec/code-tools-mixin.mdx
⬜	File I/O Tools Mixin	spec/file-io-tools-mixin.mdx
⬜	Validation Tools Mixin	spec/validation-tools-mixin.mdx
⬜	Error Fixing Mixin	spec/error-fixing-mixin.mdx
⬜	Testing Mixin	spec/testing-mixin.mdx
⬜	File Tools Mixin	spec/file-tools-mixin.mdx
⬜	RAG Tools Mixin	spec/rag-tools-mixin.mdx
⬜	Shell Tools Mixin	spec/shell-tools-mixin.mdx
⬜	File Search Mixin	spec/file-search-mixin.mdx
⬜	Code Formatting Mixin	spec/code-formatting-mixin.mdx
⬜	Project Management Mixin	spec/project-management-mixin.mdx
⬜	Prisma Tools Mixin	spec/prisma-tools-mixin.mdx
⬜	TypeScript Tools Mixin	spec/typescript-tools-mixin.mdx
⬜	External Tools Mixin	spec/external-tools-mixin.mdx
⬜	Web Tools Mixin	spec/web-tools-mixin.mdx

Packaging

Status	Document	Path	Reviewer	Notes
⬜	Web UI Packaging	spec/web-ui-packaging.mdx
⬜	NSIS Installer	spec/nsis-installer.mdx
⬜	Electron Integration	spec/electron-integration.mdx

Agents & Apps

Status	Document	Path	Reviewer	Notes
⬜	Chat Agent	spec/chat-agent.mdx
⬜	Docker Agent	spec/docker-agent.mdx
⬜	Jira Agent	spec/jira-agent.mdx
⬜	Blender Agent	spec/blender-agent.mdx
⬜	Summarizer App	spec/summarizer-app.mdx
⬜	Component Status	spec/component-status.mdx

---

Tab 3: Reference

Command Line

Status	Document	Path	Reviewer	Notes
⬜	CLI Reference	reference/cli.mdx
⬜	Features	reference/features.mdx

API & Development

Status	Document	Path	Reviewer	Notes
⬜	API	reference/api.mdx
⬜	API Spec	reference/api-spec.mdx
⬜	Development	reference/dev.mdx
⬜	Evaluation	reference/eval.mdx
⬜	Dependency Management	reference/dependency-management.mdx

Help

Status	Document	Path	Reviewer	Notes
⬜	Glossary	glossary.mdx
⬜	FAQ	reference/faq.mdx

---

Tab 4: Deployment

Integrations

Status	Document	Path	Reviewer	Notes
⬜	VS Code Integration	integrations/vscode.mdx
⬜	MCP Integration	integrations/mcp.mdx
⬜	n8n Integration	integrations/n8n.mdx

Packaging & Distribution

Status	Document	Path	Reviewer	Notes
⬜	Installer	deployment/installer.mdx
⬜	UI	deployment/ui.mdx
⬜	Testing Electron	deployment/testing-electron.mdx

---

Review Criteria Checklist

When reviewing each document, verify:

Content Quality

• Information is technically accurate
• Code examples compile/run correctly
• Screenshots/diagrams are current
• No placeholder or TODO content remains

Structure & Navigation

• Proper heading hierarchy (H1 → H2 → H3)
• Table of contents works correctly
• Related documents are properly linked

Links & References

• All internal links resolve correctly
• External links are valid and accessible
• API endpoint references are accurate
• File path references exist

Style & Consistency

• Follows GAIA documentation style guide
• Consistent terminology throughout
• Proper MDX component usage
• Code blocks have language specification

Completeness

• All features documented
• Error scenarios covered
• Prerequisites clearly stated
• Next steps provided

---

How to Review

1. Claim a document: Add your GitHub username to the Reviewer column
2. Mark as in progress: Change status to 🔄
3. Review against criteria: Use the checklist above
4. Document issues: Add notes or create linked issues for fixes needed
5. Mark complete: Change to ✅ when approved or ❌ if needs work

---

Related Issues

• Link related documentation issues here

---

Timeline

Milestone	Target Date	Status
Review kickoff		⬜
50% completion		⬜
100% review complete		⬜
All fixes applied		⬜
Final approval		⬜

---

/cc @kovtcharov-amd @eddierichter-amd @itomek-amd