Hi - I answer from the OpenSmartRoute documentation: routing, the API, plans and quotas, self-hosting. Ask away, or open a support ticket if you need a person.
Grounded in the docs - follow a source before acting on it.
Instruction file imported from daiksud/gh-qw (.github/instructions/docs.instructions.md). Copyright stays with the author.
Documentation: don't duplicate source code
Don't paste most of a real source file's contents into documentation verbatim — docs should
describe behavior and design, not duplicate the implementation.
Small snippets are fine: short examples, sample CLI usage/output, a single function signature, or
a minimal illustrative config block.
If a doc intentionally mirrors part of a real file (for example, an embedded copy of a workflow
YAML), keep it short and update it whenever the real file changes so the two don't drift.
Prefer a relative link to the real file over inlining it when the full contents matter.
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/daiksud-gh-qw-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.
daiksud-gh-qw-docs-instructions.ocm.jsonjson
{
"ocm": "1",
"id": "daiksud-gh-qw-docs-instructions",
"kind": "skill",
"name": "docs",
"description": "Documentation: don't duplicate source code",
"publisher": "daiksud",
"version": "1.0.0",
"capabilities": {
"domains": [
"coding"
],
"tags": [
"skill-md",
"github-instructions"
],
"languages": [
"en"
]
},
"quality_prior": 0.6,
"examples": [
"Documentation: don't duplicate source code"
],
"primary": false,
"metadata": {
"source": {
"provider": "github-instructions",
"repository": "https://github.com/daiksud/gh-qw",
"path": ".github/instructions/docs.instructions.md",
"ref": "0ddde8c494df320c278cc899ba56b06c3866d3cf",
"url": "https://github.com/daiksud/gh-qw/blob/0ddde8c494df320c278cc899ba56b06c3866d3cf/.github/instructions/docs.instructions.md",
"key": "daiksud/gh-qw/.github/instructions/docs.instructions.md"
},
"applies_to": "docs/**/*.md,README.md,CHANGELOG.md"
},
"instructions": "# Documentation: don't duplicate source code\n\n- Don't paste most of a real source file's contents into documentation verbatim — docs should\n describe behavior and design, not duplicate the implementation.\n- Small snippets are fine: short examples, sample CLI usage/output, a single function signature, or\n a minimal illustrative config block.\n- If a doc intentionally mirrors part of a real file (for example, an embedded copy of a workflow\n YAML), keep it short and update it whenever the real file changes so the two don't drift.\n- Prefer a relative link to the real file over inlining it when t",
"cost": {
"context_tokens": 156
}
}
Fetch it by URL: GET /api/v1/registry/daiksud-gh-qw-docs-instructions/manifest?version=1.0.0
Reviews
Star ratings from people who tried it. One review per account; edit yours any time.
No reviews yet. Install it, try it, and be the first to rate it.