Skip to content

docs: README in the shared Zentinel format - #4

Merged
raffaelschneider merged 1 commit into
mainfrom
docs/readme
Oct 21, 2026
Merged

raffaelschneider merged 1 commit into
mainfrom
docs/readme

Conversation

@raffaelschneider

Copy link
Copy Markdown
Contributor

Rewrites the README to the org-wide standard in zentinelproxy/design (readme/STANDARD.md): the shared lockup header, flat badges in the brand colors, the standard section order and footer. Commands, install paths and links were checked against the code and registries, and the quick start was run against Zentinel 0.6.50.

Corrections:
Claims corrected:

  • pip install zentinel-agent-sdk: the package is not on PyPI; install from git
  • "Full compatibility with agent protocol v2": both UDS runners use v1 framing and the gRPC server lacks the method the proxy calls; status note added
  • Quick start used run_agent (v1 framing); now the v2 runner, with the required capabilities()
  • Proxy KDL replaced with a snippet validated by zentinel test (0.6.50)
  • Docs link zentinelproxy.io/docs replaced by docs.zentinelproxy.io

Claims corrected:
- `pip install zentinel-agent-sdk`: the package is not on PyPI; install from git
- "Full compatibility with agent protocol v2": both UDS runners use v1 framing and the gRPC server lacks the method the proxy calls; status note added
- Quick start used run_agent (v1 framing); now the v2 runner, with the required capabilities()
- Proxy KDL replaced with a snippet validated by `zentinel test` (0.6.50)
- Docs link zentinelproxy.io/docs replaced by docs.zentinelproxy.io
@raffaelschneider
raffaelschneider merged commit 354acf9 into main Oct 21, 2026
3 checks passed
@raffaelschneider
raffaelschneider deleted the docs/readme branch October 21, 2026 17:38
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