Instruction file imported from taurgis/rhino-inquisitor-com (
.github/instructions/documentation-updates.instructions.md). Copyright stays with the author.
Documentation Update Gate
Mandatory Pre-Step
When this gate is triggered, consult and apply .github/skills/documentation/SKILL.md before finalizing implementation changes.
Trigger Conditions
Apply this gate when a change matched by applyTo adds, changes, or removes behavior that a maintainer or user must understand to operate the repo. Triggers include:
- New or modified scripts, workflows, templates, or configuration that changes behavior.
- New or updated quality gates, acceptance criteria, or governance requirements.
- Deprecations or removals that change how the system is used or maintained.
Documentation Update Requirements
When triggered, the change must include at least one documentation update that meets all of the following:
- Location: Update a file under
docs/**, or updateREADME.mdwhen the change affects top-level setup, build, or publishing behavior.docs/for maintainer-facing operational, process, and governance notes- Group related notes in a purpose-named subdirectory (for example
docs/publishing/ordocs/governance/) and add a short index entry when one exists
- Change summary: Describe what changed and why.
- Behavior details: Include old vs new behavior when updating an existing feature.
- Impact and verification: State impacted components or workflows and how to verify the change (steps or a reference to an existing gate).
- Related files: Link or list implementation files touched by the feature change.
If any item above is missing, the change does not pass this gate.
Exemptions
- Purely editorial or formatting-only changes with no behavior impact.
- Content-only edits under
content/**that do not alter scripts, workflows, or governance. - Changes that are exclusively documentation updates or documentation-governance scaffolding, with no runtime or workflow impact.
Precedence and Conflict Handling
If this gate overlaps with a narrower instruction (for example content-quality, hugo-coding-standards, or seo-compliance), follow both. When requirements conflict, the narrower or safety-focused instruction takes precedence; this gate only adds documentation-update requirements.
Escalation
If the documentation impact is unclear or no appropriate doc location exists, pause and ask for owner direction. If the category is clear but the target subdirectory does not exist yet, create the matching location under docs/**.