Skip to content

Docs: update README and hypaware-reference skill for current surface (fleet join, .hypignore, activity graph)#226

Merged
bgmcmullen merged 1 commit into
masterfrom
docs/readme-reference-refresh
Jul 2, 2026
Merged

Docs: update README and hypaware-reference skill for current surface (fleet join, .hypignore, activity graph)#226
bgmcmullen merged 1 commit into
masterfrom
docs/readme-reference-refresh

Conversation

@bgmcmullen

Copy link
Copy Markdown
Contributor

Summary

Bring the user-facing docs and the orientation skill up to date with the
shipped surface (currently 1.8.0). Both described a V1-only, local-only product
and omitted several capabilities that ship today.

README

  • Reframe the intro around both modes: fully local by default, with an optional
    fleet join to forward recordings to a central server.
  • Add "Joining a centrally-managed fleet (hyp join)", placed right after
    Quickstart.
  • Add a ".hypignore" folder opt-out section.
  • Add "Building and querying the activity graph" (hyp graph project /
    neighbors).
  • Remove the stale "V1 scope" and "Out of scope for V1" sections: the central
    sink and Gascity ship as opt-in bundled plugins, and third-party plugin
    install exists. Plugin inventory now stays out of the user narrative.
  • Rename "Where things live" to "Files and directories"; fix the Layout
    comments for central/gascity; drop stray "V1" labels.
  • Terminology: "central control plane" to "central server", matching CLI output.

hypaware-reference skill

  • Replace "What shipped in V1 (and what did not)" with an accurate
    "Availability" section (default / opt-in / not-provided).
  • Correct the central sink: it ships (opt-in via hyp join, forwards to a
    central server), and it is fine for an assistant to explain how to join.
  • Add hyp graph to the command map and the activity graph to capabilities.
  • De-version the frontmatter and guardrails.

Skill wiring (previously reached no client)

  • Add a tailored Codex copy of hypaware-reference. Codex has no
    hypaware-ignore/unignore skills and no per-session opt-out, so its
    .hypignore guidance points to hyp ignore / hyp unignore instead.
  • Register hypaware-reference in both plugin manifests (contributes.skills)
    and both plugin index.js skill loops, for claude and codex. The Claude side
    was never registered, so hyp skills install had not been installing it at
    all.

Testing

npm test: 1667/1670 pass. The 2 failures are pre-existing and environmental
(gpg failed to sign the data in the session-context hook tests, from the local
commit.gpgsign setting during a real git commit); they do not touch skills,
manifests, or registration.

Notes

  • AGENTS.md was reviewed and left unchanged: its only "V1" mention is an
    accurate pointer to LLP 0002 (the V1 scope decision doc), not a stale
    capability claim.

🤖 Generated with Claude Code

Bring the user-facing docs and the orientation skill up to date with the
shipped surface (currently 1.8.0). Both described a V1-only, local-only
product and omitted several capabilities that ship today.

README:
- Reframe the intro around both modes: fully local by default, with an
  optional fleet join to forward recordings to a central server.
- Add "Joining a centrally-managed fleet (hyp join)", placed right after
  Quickstart.
- Add a ".hypignore" folder opt-out section.
- Add "Building and querying the activity graph" (hyp graph project / neighbors).
- Remove the stale "V1 scope" and "Out of scope for V1" sections: the central
  sink and Gascity ship as opt-in bundled plugins, and third-party plugin
  install exists. Plugin inventory now stays out of the user narrative.
- Rename "Where things live" to "Files and directories"; fix the Layout
  comments for central/gascity; drop stray "V1" labels.
- Terminology: "central control plane" to "central server", matching CLI output.

hypaware-reference skill:
- Replace "What shipped in V1 (and what did not)" with an accurate
  "Availability" section (default / opt-in / not-provided).
- Correct the central sink: it ships (opt-in via hyp join, forwards to a
  central server), and it is fine for an assistant to explain how to join.
- Add hyp graph to the command map and the activity graph to capabilities.
- De-version the frontmatter and guardrails.

Skill wiring (the skill previously reached no client):
- Add a tailored Codex copy of hypaware-reference. Codex has no
  hypaware-ignore/unignore skills and no per-session opt-out, so its .hypignore
  guidance points to hyp ignore / hyp unignore instead.
- Register hypaware-reference in both plugin manifests (contributes.skills) and
  both plugin index.js skill loops, for claude and codex. The Claude side was
  never registered, so hyp skills install had not been installing it at all.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@bgmcmullen bgmcmullen force-pushed the docs/readme-reference-refresh branch from 6fe234d to d23d51d Compare July 1, 2026 06:58
@bgmcmullen bgmcmullen requested a review from philcunliffe July 1, 2026 07:00
@bgmcmullen bgmcmullen merged commit b411274 into master Jul 2, 2026
6 checks passed
@bgmcmullen bgmcmullen deleted the docs/readme-reference-refresh branch July 2, 2026 21:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant