docs

Name: docs
Author: devantler-tech

Use when editing Astro documentation pages, MDX content, or Starlight configuration in the docs/ directory. Covers documentation structure, Diátaxis framework, and build commands.

by devantler-tech(0) 0 installs

Free

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

See reviews

About

Instruction file imported from devantler-tech/ksail (.github/instructions/docs.instructions.md). Copyright stays with the author.

Documentation Conventions (Astro + Starlight)

Build & Preview

cd docs && npm ci && npm run build   # Validate build (dist/)
cd docs && npm run dev               # Local preview

CI uses Node.js 24. Documentation builds in ~2-3 seconds.

Content Structure

Documentation follows the Diátaxis framework:

Tutorials — Learning-oriented walkthroughs
How-to guides — Task-oriented procedures
Reference — CLI flags, API types, configuration schemas
Explanation — Architecture, design decisions

CLI Docs Generation

CLI flag reference pages are auto-generated. See docs/doc.go and docs/gen_docs_prose.go for the generator. Do not manually edit generated pages.

Conventions

Prefer Markdown (.md) over MDX (.mdx) unless interactive components are needed
Keep documentation updates in sync across README.md, index.mdx, and CONTRIBUTING.md

Use it

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

yaml

targets:
  - https://api.opensmartroute.ai/api/v1/registry/devantler-tech-ksail-docs-instructions/manifest   # or paste the manifest below

Manifest

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

devantler-tech-ksail-docs-instructions.ocm.jsonjson

{
  "ocm": "1",
  "id": "devantler-tech-ksail-docs-instructions",
  "kind": "skill",
  "name": "docs",
  "description": "Use when editing Astro documentation pages, MDX content, or Starlight configuration in the docs/ directory. Covers documentation structure, Diátaxis framework, and build commands.",
  "publisher": "devantler-tech",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "general"
    ],
    "tags": [
      "skill-md",
      "github-instructions"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Use when editing Astro documentation pages, MDX content, or Starlight configuration in the docs/ directory. Covers documentation structure, Diátaxis framework, and build commands."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "github-instructions",
      "repository": "https://github.com/devantler-tech/ksail",
      "path": ".github/instructions/docs.instructions.md",
      "ref": "213c112e3e680ba18ffe981d87d59ce0532d1047",
      "url": "https://github.com/devantler-tech/ksail/blob/213c112e3e680ba18ffe981d87d59ce0532d1047/.github/instructions/docs.instructions.md",
      "key": "devantler-tech/ksail/.github/instructions/docs.instructions.md"
    },
    "applies_to": "docs/**"
  },
  "instructions": "# Documentation Conventions (Astro + Starlight)\n\n## Build & Preview\n\n```bash\ncd docs && npm ci && npm run build   # Validate build (dist/)\ncd docs && npm run dev               # Local preview\n```\n\nCI uses Node.js 24. Documentation builds in ~2-3 seconds.\n\n## Content Structure\n\nDocumentation follows the [Diátaxis framework](https://diataxis.fr/):\n\n- **Tutorials** — Learning-oriented walkthroughs\n- **How-to guides** — Task-oriented procedures\n- **Reference** — CLI flags, API types, configuration schemas\n- **Explanation** — Architecture, design decisions\n\n## CLI Docs Generation\n\nCLI flag referenc",
  "cost": {
    "context_tokens": 229
  }
}

Fetch it by URL: GET /api/v1/registry/devantler-tech-ksail-docs-instructions/manifest?version=1.0.0