Skip to content

docs: Add kind 30177 publishing guidance for plugin authors - #558

Merged
wesbillman merged 1 commit into
mainfrom
jsib-261003-30177-docs
Oct 7, 2026
Merged

wesbillman merged 1 commit into
mainfrom
jsib-261003-30177-docs

Conversation

@jsibbison-square

@jsibbison-square jsibbison-square commented Oct 2, 2026 •

Copy link
Copy Markdown
Contributor

Kind 30177 can replace an existing local agent's shared configuration on another Buzz desktop. Add concise plugin-author guidance to publish the complete intended instance projection and preserve configuration when reusing a key, with links to upstream NIP-AP and authenticated owned-agent discovery. Link the guidance from the plugin authoring guide.

Follow-up to the documentation suggestion on #535.

Validation at 2aa5c2f0:

  • Content checked against the pinned protocol and upstream inbound behavior; local and upstream links checked.
  • git diff --check and mandatory commit/push hooks passed; documentation-only changes skip source tests/builds.
  • Agent review: 9.5/10, no blockers. Hosted DCO Check passed.
  • Draft pending human content confirmation and hosted CI.

@jsibbison-square

Copy link
Copy Markdown
Contributor Author

🤖 Agent documentation review of 2aa5c2f0: 9.5/10, no blockers. Reviewed the 23 added lines in the relay and plugin guides against the pinned NIP-AP rules and upstream inbound behavior. The projection/reused-key warning, definition-linked exception, and discovery distinction are accurate; links and diff checks pass. No app tests were run for this documentation-only change. Human content confirmation remains pending.

@jsibbison-square
jsibbison-square marked this pull request as ready for review October 6, 2026 12:14
@jsibbison-square jsibbison-square changed the title Document kind 30177 publishing for plugin authors docs: Add kind 30177 publishing guidance for plugin authors Oct 6, 2026

@wesbillman wesbillman left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No actionable changes requested. The guidance matches the host signing path and pinned upstream instance-replacement, definition-linked, and discovery contracts.

Star Lord’s automated source review via Wes’s account. Documentation/source inspection only; no tests or app execution, and human content confirmation remains unverified.

Head: 2aa5c2f01d5de5b5d5fabee37ffef16436e18b0a
Base: e8c21196fd3fc2ca9546ed1575fc886f61ff796f

@wesbillman wesbillman left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Carl, an automated reviewer, commenting via Wes’s GitHub account.

No blocking findings; 9/10. The complete-projection guidance agrees with the host/outbox contract and pinned upstream replacement, definition-link, and authenticated-discovery behavior. Independent protocol review completed and reconciled. One optional wording clarification is inline; no code changes requested.

Validation: source inspection, pinned-link/anchor checks, and exact-object git diff --check. Hosted CI required and DCO checks pass. No tests or app execution were run for these 23 documentation-only lines. Human content confirmation remains unverified; this is not an approval.

Head: 2aa5c2f01d5de5b5d5fabee37ffef16436e18b0a
Base: e8c21196fd3fc2ca9546ed1575fc886f61ff796f

Comment thread docs/relay-queries.md Outdated
can apply the event to an existing local agent with the same `d` public key,
replacing its name, `persona_id`, `parallelism`, `respond_to`, and allowlist.
When reusing a key, preserve its existing configuration in the projection;
a names-only announcement can reset omitted settings.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Optional: distinguish minimal valid content from literally name-only JSON.

{"name":"x"} is rejected by the pinned ManagedAgentEventContent parser: parallelism and respond_to are also required. That parse fails before local application. The reset warning applies to a valid but incomplete projection, such as the minimal name/parallelism/respond_to payload in the existing transport test, which can clear omitted optional configuration.

Consider replacing “a names-only announcement” with “a valid but incomplete projection”. A literal name-only payload has a different failure mode: when it becomes the latest verified owner policy, discovery excludes the agent rather than falling back.

Non-blocking: the instruction to publish the complete intended projection already avoids both failures.

Signed-off-by: Jarrod Sibbison <jsibbison@squareup.com>

@wesbillman wesbillman left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No further changes requested. The prior wording suggestion is addressed: the guidance now distinguishes malformed name-only JSON from a valid but incomplete projection, matching the pinned parser, application, and fail-closed discovery behavior.

Star Lord’s automated source follow-up via Wes’s account; head 41e5a410c577da4a289eef3de06199686aafb4af, base 5aeeda7ecd723eef84212c4578611f59412d6af8. Documentation/source and link-target inspection only; exact-object git diff --check passed, but no tests, builds, app execution or CI validation performed, and human content confirmation remains unverified.

@wesbillman
wesbillman merged commit f7c1818 into main Oct 7, 2026
22 checks passed
@wesbillman
wesbillman deleted the jsib-261003-30177-docs branch October 7, 2026 15:16
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.

2 participants