docs: refresh AGENTS.md structure, single-test runbook, pubkey guard - #6912
Open
yhc007 wants to merge 1 commit into
Open
docs: refresh AGENTS.md structure, single-test runbook, pubkey guard#6912yhc007 wants to merge 1 commit into
yhc007 wants to merge 1 commit into
Conversation
The Repo Structure listing had drifted: seven crates (buzz-deletion, buzz-relay-mesh, buzz-push-gateway, buzz-voice, buzz-backend-kubernetes, buzz-conformance, buzz-datastore-tracing) and five top-level directories (admin-web, benchmarks, examples, deploy, docs) were missing. Add a "Running a single test" section. It was absent entirely, and the per-stack invocations are not guessable: desktop unit tests are node:test over src/**/*.test.mjs behind a custom type-stripping loader rather than vitest, admin-web is vitest, and web/ has Playwright only. It also records that nothing runs `cargo test --workspace` — just test-unit enumerates packages explicitly, so a new crate gets clippy and check from workspace membership but zero executed tests until it is added to that list. Document check:pubkey-truncation next to the existing check:px-text rule; both are path:line-allowlisted guards, and the pubkey one exists because truncated prefixes are forgeable by vanity grinding. Point Key Patterns and See Also at the repo's own protocol docs (docs/nips/, docs/spec/MultiTenantRelay.tla, NOSTR.md) rather than only the upstream NIPs repo. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Signed-off-by: Paul Yu <paul.yu@unomic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Refreshes
AGENTS.md(symlinked asCLAUDE.md) in four places where it had drifted from the tree or was silent on something an agent will get wrong:Repo Structure was stale. Seven crates were missing —
buzz-deletion,buzz-relay-mesh,buzz-push-gateway,buzz-voice,buzz-backend-kubernetes,buzz-conformance,buzz-datastore-tracing— along with five top-level directories:admin-web/,benchmarks/,examples/,deploy/,docs/.New "Running a single test" section. The doc had no per-stack single-test invocation at all, and these aren't guessable: desktop unit tests are
node:testoversrc/**/*.test.mjsbehind a custom type-stripping loader (not vitest),admin-webis vitest, andweb/has Playwright only. The section also records that nothing runscargo test --workspace—just test-unitenumerates packages explicitly (Justfile:313), so a new crate gets clippy and check from workspace membership but zero executed tests until it's added to that list. The Justfile comments say this repeatedly;AGENTS.mdnever did.check:pubkey-truncationdocumented next to the existingcheck:px-textrule. Same shape (path:lineallowlist), and the rationale is non-obvious: truncated pubkey prefixes are forgeable by vanity grinding, so display truncation must go throughtruncatePubkey/<PubKey>.Protocol docs linked. Key Patterns and See Also pointed only at the upstream nostr-protocol repo, not at
docs/nips/,docs/spec/MultiTenantRelay.tla, orNOSTR.md.Docs only — no code, no behavior change.
Related issue
None found.
Testing
just file-size-checkpasses.Every claim was checked against the tree rather than asserted:
Crate and directory names read from
crates/,Cargo.tomldescriptionfields, and each crate'slib.rsheader.Test-runner claims read from
Justfile:313(test-unit) and thescriptsblocks ofdesktop/,web/, andadmin-web/package.json.The documented desktop invocation was executed after installing workspace deps:
Referenced spec files confirmed present:
docs/nips/NIP-AA.md,NIP-PL.md,NIP-MP.md, theNIP-FI*family, anddocs/spec/MultiTenantRelay.tla. An earlier draft cited "NIP-AB" as adocs/nips/example — that crate exists but the spec file does not, so the examples were corrected.Not run on this machine: the Rust, Playwright, and Flutter invocations in the new section are standard forms I did not execute.
just setupfails here before installing anything (no Docker; the Hermit-pinned pnpm also can't start — missinglibatomic.so.1), so the full suite and integration lanes were out of reach. Both are local environment limits, unrelated to this change.🤖 Generated with Claude Code