hushh-labs

docs-governance

Use when reorganizing docs, deciding documentation homes, consolidating redundant docs, updating diagrams or doc maps, or changing documentation verification policy in this repo.

hushh-labs 40 87 Updated 3mo ago

Resources

3
GitHub

Install

npx skillscat add hushh-labs/hushh-research/docs-governance

Install via the SkillsCat registry.

SKILL.md

Hussh Docs Governance Skill

Purpose and Trigger

  • Primary scope: docs-governance-intake
  • Trigger on documentation placement, docs-home decisions, consolidation, doc maps, and docs verification policy changes.
  • Avoid overlap with repo-context, frontend, and repo-operations.

Coverage and Ownership

  • Role: owner
  • Owner family: docs-governance

Owned repo surfaces:

  1. docs
  2. consent-protocol/docs
  3. hushh-webapp/docs

Non-owned surfaces:

  1. frontend
  2. backend
  3. repo-operations

Do Use

  1. Deciding where maintained docs belong across the canonical docs homes and the docs/superpowers/ planning archive.
  2. Merging, deleting, or downgrading redundant docs and updating inbound links in the same change.
  3. Updating docs maps, diagram ownership, or docs verification/governance rules.

Do Not Use

  1. Product implementation work that only happens to mention docs.
  2. Broad repo scanning before the correct owner family is known.
  3. CI/deploy/branch-protection work that belongs to repo-operations.

Read First

  1. docs/reference/operations/documentation-architecture-map.md
  2. docs/reference/operations/docs-governance.md
  3. docs/reference/README.md
  4. docs/reference/operations/documentation-recursive-knowledge-model.md
  5. docs/reference/operations/brand-and-compatibility-contract.md
  6. .codex/skills/docs-governance/references/documentation-homes.md

Workflow

  1. Classify each touched doc as canonical, pointer/index, future-plan, planning-archive, historical-provenance, merge-then-delete, or delete.
  2. Choose the correct docs home before editing content.
  3. For recursive restructures, run the folder inventory and split only when a bounded subtopic has its own owner, lifecycle, or workflow.
  4. Keep root docs thin and package-specific docs package-local.
  5. Update diagrams, inbound links, and verification references in the same change when a canonical doc changes.
  6. Keep docs/superpowers/ limited to active scoped agentic plans and design snapshots; promote durable implementation truth into docs/reference/, consent-protocol/docs/, or hushh-webapp/docs/, then delete superseded date-stamped artifacts.
  7. For contributor and setup docs, keep one blessed monorepo path and one aligned standalone upstream path; do not let legacy bootstrap instructions coexist.
  8. For command docs, verify the documented command against the real CLI or script surface after editing, then rerun docs verification once more from the canonical repo entrypoint.
  9. For founder-facing artifacts, route to founder-brief-curation and use its cadence reference instead of loading founder-only rules for ordinary docs sync.
  10. Route founder or board-facing shared briefs, architecture PDFs, and paper-style founder artifacts to founder-brief-curation after docs-home scope is clear.
  11. Keep public prose on the Hussh brand while preserving exact compatibility identifiers such as ./bin/hushh, hushh-webapp, and @hushh/mcp.
  12. Treat diagram quality and shareable-link hygiene as blocking issues for shared artifacts, not optional polish.
  13. Enforce current-state versus future-state wording for the Hussh / One / Kai / Nav / KYC ontology:
    • Hussh is platform, trust model, and infrastructure.
    • One is approved top private-agent direction unless a checked-in runtime surface proves current implementation.
    • Kai is the current finance specialist, not the platform-level identity.
    • Nav is reserved for privacy, consent, vault, deletion, and scope-review language, not ordinary navigation.
    • KYC is a bounded identity/KYC workflow specialist under One, not a second top-level app or broad email agent.
  14. Keep navigation action ids under route.* in docs. Treat nav.* as valid only for true Nav guardian capabilities or clearly marked future-roadmap prose.
  15. Do not introduce celebrity voice references or personal numeric preferences into canonical docs.
  16. Normalize founder draft language before promoting it into canonical docs:
    • approved: Hussh is the platform and trust infrastructure. One is the private agent.
    • approved: One listens, remembers, decides, and acts under consent.
    • approved: Kai is the finance specialist One summons.
    • approved: Nav is the privacy and consent guardian One summons.
    • approved: KYC is the identity workflow specialist One summons.
    • retired: Hussh is your personal MCP server and AI agent.
    • retired: One has two faces.
    • retired: Kai is the One who remembers.
  17. Treat hu_ssh and SSH for humans as secondary founder metaphors only. Keep Human Secure Socket Host as the canonical architecture expansion.
  18. Keep strong claims about on-device memory, no platform-controlled recovery, BYO model execution, portable One memory, and user-private action receipts in docs/future/ until implementation docs and tests prove them.
  19. For information-model docs, distinguish encrypted PKM memory from provider caches, workflow state, audit metadata, reference information, and analytics warehouse truth. Provider/cache tables are not durable user memory unless a consented encrypted PKM write makes them so.
  20. In human-facing prose, call One the private agent and use information or a specific noun in place of generic data. Preserve exact code, API, route, schema, protocol, and compatibility identifiers.
  21. Treat long-doc findings as navigation prompts, not automatic split orders. Add subfolders or child docs only when a bounded subtopic has its own owner, lifecycle, or reusable entrypoint.
  22. Route documentation updates must follow the route contract cascade: route contracts, frontend/native surface map docs, cache coherence, One Voice, mobile parity, and owning skill reads/checks must agree before calling a route change documented.

Handoff Rules

  1. If the task starts with broad repo orientation or ambiguous ownership, start with repo-context.
  2. If the work is primarily frontend structure, use frontend.
  3. If the work is primarily backend runtime or package behavior, use backend.
  4. If the work is operational policy rather than docs policy, use repo-operations.
  5. If the work is primarily contributor-first-run experience or bootstrap contract ownership, use contributor-onboarding.
  6. If the work is a founder-facing architecture brief or shared PDF artifact, use founder-brief-curation.

Required Checks

./bin/hushh docs verify
python3 .codex/skills/docs-governance/scripts/doc_inventory.py tier-a
python3 .codex/skills/docs-governance/scripts/doc_inventory.py stale-candidates
python3 .codex/skills/docs-governance/scripts/doc_inventory.py folders

Categories