Instruction file imported from dianlight/hassio-addons (.github/instructions/docs.instructions.md). Copyright stays with the author.

Documentation Guidelines

Name: Add-on Documentation Consistency
Author: dianlight

Keep documentation self-contained per add-on.
Do not copy feature descriptions from one add-on into another.
Match documentation to the add-on lifecycle state:
- sambanas is maintenance mode.
- sambanas2 is active development.
- RPiMySensor and plex are deprecated/legacy.

Required Updates

When behavior, configuration, or services change in an add-on, update all relevant files in that same add-on directory:

README.md: user-visible behavior, install, requirements, status.
DOCS.md: configuration options, examples, service behavior.
CHANGELOG.md: Added/Changed/Fixed/Removed/Breaking Changes as applicable.

Changelog Format

Follow the repository template in .github/CHANGELOG_TEMPLATE.md.
Keep entries specific and actionable; include migration notes for breaking changes.

Validation

Ensure examples reflect current config keys and defaults.
Ensure links are local to the same add-on unless intentionally pointing to repository-level docs.

{ "ocm": "1", "id": "dianlight-hassio-addons-docs-instructions", "kind": "skill", "name": "Add-on Documentation Consistency", "description": "Use when updating README.md, DOCS.md, or CHANGELOG.md for any add-on. Enforces per-add-on isolation and changelog consistency.", "publisher": "dianlight", "version": "1.0.0", "capabilities": { "domains": [ "general" ], "tags": [ "skill-md", "github-instructions" ], "languages": [ "en" ] }, "quality_prior": 0.6, "examples": [ "Use when updating README.md, DOCS.md, or CHANGELOG.md for any add-on. Enforces per-add-on isolation and changelog consistency." ], "primary": false, "metadata": { "source": { "provider": "github-instructions", "repository": "https://github.com/dianlight/hassio-addons", "path": ".github/instructions/docs.instructions.md", "ref": "d64b84f25bfe50803b55697a1dddafcccf62e5e5", "url": "https://github.com/dianlight/hassio-addons/blob/d64b84f25bfe50803b55697a1dddafcccf62e5e5/.github/instructions/docs.instructions.md", "key": "dianlight/hassio-addons/.github/instructions/docs.instructions.md" }, "applies_to": [ "**/README.md", "**/DOCS.md", "**/CHANGELOG.md" ] }, "instructions": "# Documentation Guidelines\n\n- Keep documentation self-contained per add-on.\n- Do not copy feature descriptions from one add-on into another.\n- Match documentation to the add-on lifecycle state:\n - `sambanas` is maintenance mode.\n - `sambanas2` is active development.\n - `RPiMySensor` and `plex` are deprecated/legacy.\n\n## Required Updates\n\nWhen behavior, configuration, or services change in an add-on, update all relevant files in that same add-on directory:\n- `README.md`: user-visible behavior, install, requirements, status.\n- `DOCS.md`: configuration options, examples, service behavior.\n- `C", "cost": { "context_tokens": 263 } }

Add-on Documentation Consistency

About

Documentation Guidelines

Required Updates

Changelog Format

Validation

Use it

Manifest

Reviews