2:I[7012,["4765","static/chunks/4765-f5afdf8061f456f3.js","9856","static/chunks/9856-3b185291364d9bef.js","6687","static/chunks/app/docs/%5B...slug%5D/page-e07536548216bee4.js"],"MarkdownRenderer"]
4:I[9856,["4765","static/chunks/4765-f5afdf8061f456f3.js","9856","static/chunks/9856-3b185291364d9bef.js","6687","static/chunks/app/docs/%5B...slug%5D/page-e07536548216bee4.js"],""]
5:I[4126,[],""]
7:I[9630,[],""]
8:I[4278,["9856","static/chunks/9856-3b185291364d9bef.js","8172","static/chunks/8172-b3a2d6fe4ae10d40.js","3185","static/chunks/app/layout-2814fa5d15b84fe4.js"],"HeadingProvider"]
9:I[1476,["9856","static/chunks/9856-3b185291364d9bef.js","8172","static/chunks/8172-b3a2d6fe4ae10d40.js","3185","static/chunks/app/layout-2814fa5d15b84fe4.js"],"Header"]
a:I[3167,["9856","static/chunks/9856-3b185291364d9bef.js","8172","static/chunks/8172-b3a2d6fe4ae10d40.js","3185","static/chunks/app/layout-2814fa5d15b84fe4.js"],"Sidebar"]
b:I[7409,["9856","static/chunks/9856-3b185291364d9bef.js","8172","static/chunks/8172-b3a2d6fe4ae10d40.js","3185","static/chunks/app/layout-2814fa5d15b84fe4.js"],"PageFrame"]
3:T20d1,
# Documentation Guide for AI Agents

This page explains how AI agents should navigate and use the VoiceAssist documentation system to efficiently gather context and find relevant information.

---

## Quick Start for AI Agents

### 1. Fetch the Index

Start by fetching the agent JSON index to discover available endpoints:

```bash
curl https://assistdocs.asimo.io/agent/index.json
```

### 2. Load Documentation Summaries

For quick context, fetch the docs-summary endpoint which aggregates `ai_summary` fields:

```bash
curl https://assistdocs.asimo.io/agent/docs-summary.json
```

### 3. Check Documentation Health

Monitor documentation freshness and coverage:

```bash
curl https://assistdocs.asimo.io/agent/health.json
```

---

## Agent JSON Endpoints

All endpoints are available at `https://assistdocs.asimo.io/agent/`

| Endpoint                    | Purpose                           | Best For                |
| --------------------------- | --------------------------------- | ----------------------- |
| `/agent/index.json`         | Lists all available endpoints     | Initial discovery       |
| `/agent/docs.json`          | Full document index with metadata | Browsing/filtering docs |
| `/agent/docs-summary.json`  | AI-friendly summaries by category | Quick context loading   |
| `/agent/code-examples.json` | Code snippets with semantic tags  | Finding implementation  |
| `/agent/status.json`        | System status and feature flags   | Health checks           |
| `/agent/health.json`        | Documentation health metrics      | Quality monitoring      |
| `/agent/activity.json`      | Recent changes                    | Staying up to date      |
| `/agent/todos.json`         | Pending documentation tasks       | Finding work items      |
| `/search-index.json`        | Full-text search index            | Client-side searching   |

### Code Examples Endpoint

The `/agent/code-examples.json` endpoint provides 3,290+ code snippets with semantic tags:

```bash
curl https://assistdocs.asimo.io/agent/code-examples.json | jq '.by_tag | keys'
```

**Available tags**: `api`, `authentication`, `cache`, `component`, `config`, `database`, `docker`, `environment`, `git`, `http`, `infrastructure`, `kubernetes`, `package-manager`, `react`, `realtime`, `snippet`, `system`, `testing`

---

## Understanding Frontmatter

Every markdown document includes frontmatter metadata. Key fields for AI agents:

### Essential Fields

```yaml
---
title: Document Title
summary: One-line description
ai_summary: 2-3 sentence summary optimized for AI context loading
status: stable | draft | experimental | deprecated
lastUpdated: "2025-12-04"
---
```

### AI-Specific Fields

```yaml
---
ai_summary: Use this field for quick understanding. It's written specifically
  for AI agents to rapidly grasp document content without reading the full text.
audience: ["ai-agents", "developers"] # Check if you're the target audience
category: reference | planning | api | architecture | operations
owner: backend | frontend | docs | security # Who maintains this doc
---
```

### Using ai_summary

The `ai_summary` field provides:

- 2-3 sentences summarizing the document
- Key technical details relevant to implementation
- Cross-references to related documents when applicable

**Example:**

```yaml
ai_summary: Feature flags enable runtime toggles without deployments.
  Use category.feature_name pattern (e.g., ui.dark_mode).
  Stored in PostgreSQL, cached in Redis (5min TTL).
```

---

## Directory Structure

```
docs/
├── admin-guide/           # Admin panel and configuration docs
│   ├── feature-flags/     # Feature flag system documentation
│   │   ├── README.md              # Overview
│   │   ├── naming-conventions.md  # Naming patterns
│   │   ├── lifecycle.md           # Flag lifecycle
│   │   ├── advanced-types.md      # Boolean, percentage, variant, scheduled
│   │   ├── multi-environment.md   # Dev, staging, prod
│   │   ├── admin-panel-guide.md   # UI usage
│   │   └── best-practices.md      # Guidelines
│   └── for-ai-agents.md   # This document
│
├── admin/                 # Admin panel implementation
├── ai/                    # AI/ML features (RAG, embeddings)
├── api/                   # API specifications
├── architecture/          # System architecture
├── debugging/             # Troubleshooting guides
├── deployment/            # Deployment procedures
├── integration/           # Integration guides
├── operations/            # Operational runbooks
├── planning/              # Feature planning
├── reference/             # Reference documentation
├── security/              # Security documentation
├── testing/               # Testing guides
└── voice/                 # Voice mode documentation
```

---

## Recommended Workflow for AI Agents

### When answering questions about VoiceAssist:

1. **Check docs-summary.json first**
   - Look for relevant `ai_summary` entries
   - Filter by `category` or `audience`

2. **Use full docs.json for details**
   - Find specific documents matching the query
   - Note `lastUpdated` for freshness

3. **Fetch specific documents as needed**
   - Read the full markdown for implementation details
   - Check related documents listed in "Related Documentation" sections

### When writing code:

1. **Check feature flags status**
   - `GET /agent/status.json` → `feature_flags` section
   - Verify if features are enabled/disabled

2. **Find API documentation**
   - Filter docs.json by `category: "api"`
   - Look for OpenAPI specs in `/api/` directory

3. **Check architectural patterns**
   - Filter by `category: "architecture"`
   - Review component diagrams and data flow

### When debugging:

1. **Check health metrics**
   - `GET /agent/health.json` for documentation status
   - Look for stale or missing docs

2. **Search for troubleshooting guides**
   - Filter by `category: "debugging"`
   - Check `docs/debugging/` directory

---

## Filtering and Searching

### By Category

Available categories:

- `ai` - AI/ML features (RAG, embeddings, NLU)
- `api` - API endpoints and specifications
- `architecture` - System design and patterns
- `debugging` - Troubleshooting guides
- `deployment` - Deployment and infrastructure
- `operations` - Operational procedures
- `planning` - Feature planning and roadmaps
- `reference` - Reference documentation
- `security` - Security guidelines
- `testing` - Testing strategies
- `feature-flags` - Feature flag system

### By Audience

Target audiences include:

- `ai-agents` - Documentation optimized for AI consumption
- `developers` - Implementation details for engineers
- `admin` - Admin panel users
- `devops` - Infrastructure and deployment
- `frontend` - Frontend development
- `backend` - Backend development
- `sre` - Site reliability engineering

### By Status

- `stable` - Production-ready documentation
- `draft` - Work in progress
- `experimental` - New features being tested
- `deprecated` - Outdated, will be removed

---

## Current Documentation Metrics

Check `/agent/health.json` for real-time metrics. Current status:

| Metric          | Value     |
| --------------- | --------- |
| Total Documents | 254       |
| With AI Summary | 219 (86%) |
| Code Examples   | 3,290+    |
| Languages       | 26        |
| Semantic Tags   | 18        |
| Categories      | 13        |
| Health Status   | Healthy   |

---

## Best Practices for AI Agents

1. **Prefer ai_summary over full text** when you only need a quick understanding
2. **Check lastUpdated** before using documentation (prefer recent docs)
3. **Filter by audience** to find relevant docs faster
4. **Use health.json** to identify stale or incomplete areas
5. **Use code-examples.json by_tag** to find implementation patterns
6. **Follow cross-references** in "Related Documentation" sections
7. **Cache endpoints** - JSON endpoints can be cached for performance

---

## Related Documentation

- [Feature Flags Overview](./feature-flags/README.md)
- [System Settings vs Feature Flags](./system-settings-vs-flags.md)
- [Admin Panel Integration Guide](../admin/ADMIN_PANEL_INTEGRATION_GUIDE.md)

---

**Document Version**: 1.0
**Last Updated**: 2025-12-04
**Maintained By**: VoiceAssist Documentation Team
6:["slug","admin-guide/for-ai-agents","c"]
0:["X7oMT3VrOffzp0qvbeOas",[[["",{"children":["docs",{"children":[["slug","admin-guide/for-ai-agents","c"],{"children":["__PAGE__?{\"slug\":[\"admin-guide\",\"for-ai-agents\"]}",{}]}]}]},"$undefined","$undefined",true],["",{"children":["docs",{"children":[["slug","admin-guide/for-ai-agents","c"],{"children":["__PAGE__",{},[["$L1",["$","div",null,{"children":[["$","div",null,{"className":"mb-6 flex items-center justify-between gap-4","children":[["$","div",null,{"children":[["$","p",null,{"className":"text-sm text-gray-500 dark:text-gray-400","children":"Docs / Raw"}],["$","h1",null,{"className":"text-3xl font-bold text-gray-900 dark:text-white","children":"Documentation Guide for AI Agents"}],["$","p",null,{"className":"text-sm text-gray-600 dark:text-gray-400","children":["Sourced from"," ",["$","code",null,{"className":"font-mono text-xs","children":["docs/","admin-guide/for-ai-agents.md"]}]]}]]}],["$","a",null,{"href":"https://github.com/mohammednazmy/VoiceAssist/edit/main/docs/admin-guide/for-ai-agents.md","target":"_blank","rel":"noreferrer","className":"inline-flex items-center gap-2 rounded-md border border-gray-200 dark:border-gray-700 px-3 py-1.5 text-sm text-gray-700 dark:text-gray-200 hover:border-primary-500 dark:hover:border-primary-400 hover:text-primary-700 dark:hover:text-primary-300","children":"Edit on GitHub"}]]}],["$","div",null,{"className":"rounded-lg border border-gray-200 dark:border-gray-800 bg-white dark:bg-gray-900 p-6","children":["$","$L2",null,{"content":"$3"}]}],["$","div",null,{"className":"mt-6 flex flex-wrap gap-2 text-sm","children":[["$","$L4",null,{"href":"/reference/all-docs","className":"inline-flex items-center gap-1 rounded-md bg-gray-100 px-3 py-1 text-gray-700 hover:bg-gray-200 dark:bg-gray-800 dark:text-gray-200 dark:hover:bg-gray-700","children":"← All documentation"}],["$","$L4",null,{"href":"/","className":"inline-flex items-center gap-1 rounded-md bg-gray-100 px-3 py-1 text-gray-700 hover:bg-gray-200 dark:bg-gray-800 dark:text-gray-200 dark:hover:bg-gray-700","children":"Home"}]]}]]}],null],null],null]},[null,["$","$L5",null,{"parallelRouterKey":"children","segmentPath":["children","docs","children","$6","children"],"error":"$undefined","errorStyles":"$undefined","errorScripts":"$undefined","template":["$","$L7",null,{}],"templateStyles":"$undefined","templateScripts":"$undefined","notFound":"$undefined","notFoundStyles":"$undefined"}]],null]},[null,["$","$L5",null,{"parallelRouterKey":"children","segmentPath":["children","docs","children"],"error":"$undefined","errorStyles":"$undefined","errorScripts":"$undefined","template":["$","$L7",null,{}],"templateStyles":"$undefined","templateScripts":"$undefined","notFound":"$undefined","notFoundStyles":"$undefined"}]],null]},[[[["$","link","0",{"rel":"stylesheet","href":"/_next/static/css/7f586cdbbaa33ff7.css","precedence":"next","crossOrigin":"$undefined"}]],["$","html",null,{"lang":"en","className":"h-full","children":["$","body",null,{"className":"__className_f367f3 h-full bg-white dark:bg-gray-900","children":[["$","a",null,{"href":"#main-content","className":"skip-to-content","children":"Skip to main content"}],["$","$L8",null,{"children":[["$","$L9",null,{}],["$","$La",null,{}],["$","main",null,{"id":"main-content","className":"lg:pl-64","role":"main","aria-label":"Documentation content","children":["$","$Lb",null,{"children":["$","$L5",null,{"parallelRouterKey":"children","segmentPath":["children"],"error":"$undefined","errorStyles":"$undefined","errorScripts":"$undefined","template":["$","$L7",null,{}],"templateStyles":"$undefined","templateScripts":"$undefined","notFound":[["$","title",null,{"children":"404: This page could not be found."}],["$","div",null,{"style":{"fontFamily":"system-ui,\"Segoe UI\",Roboto,Helvetica,Arial,sans-serif,\"Apple Color Emoji\",\"Segoe UI Emoji\"","height":"100vh","textAlign":"center","display":"flex","flexDirection":"column","alignItems":"center","justifyContent":"center"},"children":["$","div",null,{"children":[["$","style",null,{"dangerouslySetInnerHTML":{"__html":"body{color:#000;background:#fff;margin:0}.next-error-h1{border-right:1px solid rgba(0,0,0,.3)}@media (prefers-color-scheme:dark){body{color:#fff;background:#000}.next-error-h1{border-right:1px solid rgba(255,255,255,.3)}}"}}],["$","h1",null,{"className":"next-error-h1","style":{"display":"inline-block","margin":"0 20px 0 0","padding":"0 23px 0 0","fontSize":24,"fontWeight":500,"verticalAlign":"top","lineHeight":"49px"},"children":"404"}],["$","div",null,{"style":{"display":"inline-block"},"children":["$","h2",null,{"style":{"fontSize":14,"fontWeight":400,"lineHeight":"49px","margin":0},"children":"This page could not be found."}]}]]}]}]],"notFoundStyles":[]}]}]}]]}]]}]}]],null],null],["$Lc",null]]]]
c:[["$","meta","0",{"name":"viewport","content":"width=device-width, initial-scale=1"}],["$","meta","1",{"charSet":"utf-8"}],["$","title","2",{"children":"Documentation Guide for AI Agents | Docs | VoiceAssist Docs"}],["$","meta","3",{"name":"description","content":"Guide for AI agents on how to navigate and use VoiceAssist documentation effectively"}],["$","meta","4",{"name":"keywords","content":"VoiceAssist,documentation,medical AI,voice assistant,healthcare,HIPAA,API"}],["$","meta","5",{"name":"robots","content":"index, follow"}],["$","meta","6",{"name":"googlebot","content":"index, follow"}],["$","link","7",{"rel":"canonical","href":"https://assistdocs.asimo.io"}],["$","meta","8",{"property":"og:title","content":"VoiceAssist Documentation"}],["$","meta","9",{"property":"og:description","content":"Comprehensive documentation for VoiceAssist - Enterprise Medical AI Assistant"}],["$","meta","10",{"property":"og:url","content":"https://assistdocs.asimo.io"}],["$","meta","11",{"property":"og:site_name","content":"VoiceAssist Docs"}],["$","meta","12",{"property":"og:type","content":"website"}],["$","meta","13",{"name":"twitter:card","content":"summary"}],["$","meta","14",{"name":"twitter:title","content":"VoiceAssist Documentation"}],["$","meta","15",{"name":"twitter:description","content":"Comprehensive documentation for VoiceAssist - Enterprise Medical AI Assistant"}],["$","meta","16",{"name":"next-size-adjust"}]]
1:null