Ask which docs path a contribution should take. A user-started orchestrator.
56
64%
Does it follow best practices?
Run evals on this skill
Adds up to 20 points to the overall score
View guide
Passed
No findings from the security scan
Fix and improve this skill with Tessl
tessl review fix ./plugins/documentation/skills/docs-contribution-router/SKILL.mdRoute contributors to the right content type, placement, and workflow before they start writing. Output a clear action plan: content type, file path, frontmatter starter, and a sidebar label suggestion.
It does not write the page (that's docs-writing-style).
Do not wait for a polished proposal. Route on stated intent. "I want to document X" is enough.
Every contribution has an established path. Surface it immediately so the contributor writes the right thing in the right place the first time.
Map contributor intent to a branch. Ask one clarifying question only if the intent is genuinely ambiguous.
| Stated intent | Branch |
|---|---|
| Update the API reference / OpenAPI spec / scalar.yaml | API reference |
| Document a customer issue / add new info / new guide / new concept / FAQ | Content placement |
| Write an integration guide / add screenshots | Integration guide |
When intent spans two branches, handle placement first, then the other branch.
For Scalekit agent-connector docs or Scalekit escalation / CODEOWNERS review, stop. That work lives in skillkit docs-engineering.
Load
references/api-reference-flow.mdfor the full step-by-step workflow.
Key facts:
If the contributor wants to change what appears in the API reference (not just update it), redirect: the change must happen in the source repository.
Load
references/placement-decisions.mdfor the full decision tree and Aside anti-pattern rules. Loadreferences/scalekit-placement-map.json(or<docs-repo>/.devex-kit/placement-map.jsonif the consumer has one).
Ask: "What is the reader trying to accomplish when they land on this content?"
| Reader goal | Content type | Placement |
|---|---|---|
| Solve one specific implementation problem | Cookbook recipe | cookbooks/<slug>.mdx |
| Follow a task step by step within a product | How-to guide | <product>/guides/<task>.mdx |
| Understand a concept, architecture, or pattern | Concept page | <product>/concepts/<concept>.mdx |
| Look up reference data (API shapes, errors, events) | Reference | reference/<topic>.mdx or API ref |
| Get started with a product for the first time | Quickstart | <product>/quickstart.mdx |
Aside anti-pattern: promote when any of these is true:
<Aside> exceeds 3 sentences.Promote to: a dedicated page (full topic), a cookbook recipe (implementation pattern), or a <details> FAQ block at the bottom of the existing page (short clarification).
Load
references/integration-guide-template.mdfor the section skeleton and frontmatter. Loadreferences/screenshot-workflow.mdfor the paste-image plugin setup and naming conventions.
Key facts:
src/content/docs/guides/integrations/<category>/<provider>/..vscode/extensions.json). It pastes images directly into the correct asset path with the correct URL pattern.For every routing decision, produce:
Content type: <type>
File path: <proposed path>
Frontmatter:
title: '<≤60 chars>'
description: '<≤160 chars>'
sidebar.label: '<1–3 words, sentence case>'Then: one short paragraph describing what the page should cover and how it fits the reader's journey.
At the end of every session, ask: "Did this solve what you were trying to do?"
This skill is site-agnostic. To adapt placement:
references/_template-placement-map.json → <your-docs-repo>/.devex-kit/placement-map.json and fill in your folder conventions.<docs-repo>/.devex-kit/placement-map.json first.Scalekit agent-connector flows and Scalekit escalation / CODEOWNERS rules live in skillkit docs-engineering. Do not recreate them here.
df60de1
If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.