maintain-hldd
Skill1 starsChanged 49 days agoMITView on GitHub
Keep Vivary's canonical high-level design aligned with source, product contracts, and acceptance evidence. Use when changing Vivary implementation, configuration, architecture, delivery checks, or durable product documentation.
In this repository8 other files it gives its agents.
- AGENTS.mdAGENTS.md
- CLAUDE.mdCLAUDE.md
- entire-searchSkill
- loopsSkill
- entire-searchSkill
- entireSkill
- loopsSkill
- maintain-hlddSkill
The file
We split this skill into the rules it gives an agent
5 rules. About 0 are common, 4 are distinctive, and 1 is very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈4
Distinctive · estimate
This author's own choices. Worth a look.
1
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 8
Read docs/ARCHITECTURE.md before implementation.
- Distinctive: line 11
Read the source owners and evidence linked from the affected sections.
- Distinctive: line 15
Update affected design sections alongside source changes.
- Distinctive: line 22
Keep the staged change coherent:
- Distinctive: line 56
Before delivery, report what the HLDD now explains, what evidence supports it, and any remaining acceptance gaps.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Maintain Vivary's high-level design
Read docs/ARCHITECTURE.md before implementation. It is the canonical HLDD.
Detailed contracts stay in their existing documents. GitHub issues own task status.
Read the source owners and evidence linked from the affected sections. Preserve Jeff's stated intent, success criteria, and editorial remarks. Do not invent a rationale or relabel planned or untested behavior as implemented or accepted.
Update affected design sections alongside source changes. Keep the explanation at component, flow, persistence, or trust-boundary level. Link deeper details instead of copying them. If the design remains accurate, update Last change review with the specific changed area, why its description still holds, and the evidence inspected. A date, hash, generic acknowledgement, or unrelated sentence is not a review.
Keep the staged change coherent:
- Inspect
git diff --cachedand update the relevant HLDD sections. - Stage the document with the source change.
- Run
python scripts/check_hldd.py --staged. - Review the actual text against the implementation. The gate checks that a review was recorded, not whether its claims are true.
Install the repository hook in each checkout with
python scripts/check_hldd.py --install-hook. It preserves existing hooks and
refuses to replace a hook manager or a different pre-commit hook. Integrate the
same staged command into an existing chain when needed. Linked worktrees share
Git hooks. The supplied hook only runs in trees that track this checker.
CI checks each introduced commit using
python scripts/check_hldd.py --base <base-ref> --head <head-ref>.
Commits preceding gate adoption remain historical. Source changes on merged
side branches are checked too. Test-only and generated site-mirror changes
do not require documentation churn. Source, delivery scripts,
workflow, project instruction, and durable documentation changes do. Whitespace,
comments, and date-only edits do not satisfy the gate. Do not bypass a failure.
The branch check, never the staged hook, passes a Dependabot-authored commit whose
relevant changes are version-only edits to dependency manifests or workflow
action refs, or lockfile changes. It does not inspect lockfile content. It also
passes a merge commit whose change against its first parent is version-only
when it takes a merged branch's copy of a dependency file the other line left
alone. The range must have checked every commit on that branch, counting
commits already on the base branch as checked. The dependency review in
CONTRIBUTING.md covers what a lockfile brings in.
The application bundles this same Markdown at build time in Settings > Documentation. Do not hand-maintain a second copy. Check the built reader when its rendering or navigation changes. Run the existing site documentation sync when canonical docs change.
Before delivery, report what the HLDD now explains, what evidence supports it, and any remaining acceptance gaps. Preserve the existing review and approval requirements. This skill grants no publication or transcript-upload authority.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

