ai-docs

Name: ai-docs
Author: joshyorko

Guidelines for creating and maintaining AI documentation in ai_docs/

by joshyorko(0) 0 installs

Free

Free account. Installing gives you the manifest plus copy-paste snippets.

See reviews

About

Instruction file imported from joshyorko/context-eng-copilot (.github/instructions/ai-docs.instructions.md). Copyright stays with the author.

AI Documentation Standards

Purpose

Provide context-specific documentation for AI agents, including patterns, troubleshooting, validation, and context engineering guides.

Structure

Use Markdown with clear headings and examples
Organize by category: patterns, troubleshooting, validation, context
Each file should be under 500 lines

Content Guidelines

Include actionable examples and code snippets
Document common issues and solutions
Reference project-specific patterns and constraints
Update docs as features and workflows evolve

Maintenance

Review and update regularly for accuracy
Remove outdated or irrelevant content
Ensure all referenced files and links are valid

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

# after Install: the listing is in your workspace's routing pool - a plan picks it for its slot
curl -s -X POST https://api.opensmartroute.ai/api/v1/route -H 'Authorization: Bearer $OSR_API_KEY' -H 'Content-Type: application/json' -d '{"text": "...", "plan": true}'

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

joshyorko-context-eng-copilot-ai-docs-instructions.ocm.jsonjson

{
  "ocm": "1",
  "id": "joshyorko-context-eng-copilot-ai-docs-instructions",
  "kind": "skill",
  "name": "ai-docs",
  "description": "Guidelines for creating and maintaining AI documentation in ai_docs/",
  "publisher": "joshyorko",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "general"
    ],
    "tags": [
      "skill-md",
      "github-instructions"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Guidelines for creating and maintaining AI documentation in ai_docs/"
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "github-instructions",
      "repository": "https://github.com/joshyorko/context-eng-copilot",
      "path": ".github/instructions/ai-docs.instructions.md",
      "ref": "d1d44df3f8555318613fbb699e86405f1f0c82e0",
      "url": "https://github.com/joshyorko/context-eng-copilot/blob/d1d44df3f8555318613fbb699e86405f1f0c82e0/.github/instructions/ai-docs.instructions.md",
      "key": "joshyorko/context-eng-copilot/.github/instructions/ai-docs.instructions.md"
    },
    "applies_to": "PRPs/ai_docs/*.md"
  },
  "instructions": "# AI Documentation Standards\n\n## Purpose\nProvide context-specific documentation for AI agents, including patterns, troubleshooting, validation, and context engineering guides.\n\n## Structure\n- Use Markdown with clear headings and examples\n- Organize by category: patterns, troubleshooting, validation, context\n- Each file should be under 500 lines\n\n## Content Guidelines\n- Include actionable examples and code snippets\n- Document common issues and solutions\n- Reference project-specific patterns and constraints\n- Update docs as features and workflows evolve\n\n## Maintenance\n- Review and update regula",
  "cost": {
    "context_tokens": 176
  }
}

Fetch it by URL: GET /api/v1/registry/joshyorko-context-eng-copilot-ai-docs-instructions/manifest?version=1.0.0