Skip to content

Use Documentation for Agents and RAG

Agents and RAG pipelines depend on stable structure, IDs, and machine-readable access to documents.

Goal

Make documentation reliably searchable and citeable by tools, with deterministic outputs and stable

metadata contracts.

Steps

  1. Ensure docs follow templates and metadata standards (EN source).
  2. Ensure translations are linked and checked (i18n lint where required).
  3. Produce trace outputs that can feed downstream analysis.
  4. Provide structured access patterns (CLI now; MCP later).

Outputs

  • Deterministic, ID-addressable docs
  • Trace graph exports for knowledge graphs
  • A predictable interface for automation

Failure Modes

  • Metadata drift and inconsistent IDs.
  • Weak or missing diagnostics contract.
  • Mixed-language trees without clear source/translation rules.
  • arqix doc list
  • arqix doc read
  • arqix doc search
  • arqix trace scan
  • arqix lint run --profile i18n

Automation

  • arqix mcp serve