Skip to content

docs: align SKILL, README, and primers with v0.14.0#3

Open
JimCollinson wants to merge 3 commits into
mainfrom
docs/v014-align-skill-readme-primers
Open

docs: align SKILL, README, and primers with v0.14.0#3
JimCollinson wants to merge 3 commits into
mainfrom
docs/v014-align-skill-readme-primers

Conversation

@JimCollinson
Copy link
Copy Markdown
Owner

This is a fork-only docs review branch for Greptile / diff inspection. Not intended as an upstream PR yet.

What’s in scope:

  • update SKILL.md to match current v0.14.0 install/auth/CLI reality
  • fix stale examples in README.md
  • apply small release-alignment fixes in the primers

Main fixes:

  • align stale version references to v0.14.0
  • fix x0x agent card syntax
  • remove stale fixed endpoint-count references
  • refresh install/start guidance and auth examples
  • fix stale WebSocket/example payload shapes
  • remove nonexistent x0x tasks join from coordination.md
  • update small wording/status issues in files.md, apps.md, and other primers

Out of scope:

  • no code changes
  • no product behavior changes
  • no broader rewrite of groups.md
  • no upstream PR yet

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented Mar 30, 2026

Greptile Summary

This PR aligns SKILL.md, README.md, and all seven documentation primers with the v0.14.0 release. The changes are docs-only with no code or behaviour modifications.

Key improvements:

  • Version references updated from v0.11.0 to v0.14.0 across all primers
  • x0x CLI binary added alongside x0xd in all install paths (pre-built, script, and source builds)
  • Start/stop workflow updated from x0xd invocation to x0x start / x0x stop
  • REST examples updated with Authorization: Bearer headers that were missing from several curl calls
  • Dynamic api.port discovery added to all API examples in place of hardcoded 127.0.0.1:12700
  • WebSocket message shapes corrected: actiontype, single topic string → topics array for subscribe, senderorigin for gossip messages
  • x0x tasks join (nonexistent command) replaced with the correct x0x tasks create pattern in coordination.md
  • Stale fixed endpoint-count references (70 endpoints) removed
  • x0x agent card --name flag removed in favour of positional argument
  • x0x presence corrected to x0x presence online

Two minor P2 items noted:

  • The HTML chat example in README.md keeps a hardcoded port 12700 without comment, contradicting the api.port guidance added to apps.md in the same PR
  • The coordination.md Agent B example uses the identical x0x tasks create command and list name as Agent A without clarifying that the topic (not the name) is the shared sync identifier

Confidence Score: 5/5

Safe to merge — docs-only PR with no code changes and only minor P2 clarity suggestions remaining.

All findings are P2 style/clarity suggestions that do not affect correctness, security, or runtime behaviour. The alignment work is thorough and internally consistent across all nine changed files.

No files require special attention. The README.md HTML example and coordination.md Agent B example have minor clarity gaps but nothing that blocks merge.

Important Files Changed

Filename Overview
README.md Version bumped to v0.14.0; stale endpoint counts removed; WebSocket payload shapes updated (action→type, topics array, sender→origin); dynamic api.port discovery added to all REST examples; agent card, presence, and upgrade commands corrected. Hardcoded port 12700 remains in HTML example without a note, minor inconsistency with the api.port guidance.
SKILL.md Version metadata updated to 0.14.0; x0x CLI binary added to all install targets alongside x0xd; install/start/verify steps rewritten to use x0x start; auth bearer tokens added to all previously unprotected curl examples; new identity_dir/data_dir split documented; CLI reference replaced with current v0.14 commands.
docs/primers/coordination.md Version bumped to v0.14.0; nonexistent x0x tasks join replaced with x0x tasks create using the same topic, which is correct but uses identical command and name for both Agent A and Agent B without explaining the idempotency/bind semantics.
docs/primers/apps.md Version bumped to v0.14.0; premature file-transfer caution caveat removed now that the feature is stable.
docs/primers/files.md Version bumped to v0.14.0; x0x receive-file comment reworded from 'pending incoming transfers' to 'Watch for incoming transfer offers' for accuracy.
docs/primers/identity.md Version bumped to v0.14.0; x0x agent card --name flag removed to match current CLI positional argument syntax.
docs/primers/messaging.md Version reference updated from v0.11.0 to v0.14.0 in the status banner; no other content changes.
docs/primers/trust.md Version reference updated from v0.11.0 to v0.14.0; no other content changes.
docs/primers/groups.md Version reference updated from v0.11.0 to v0.14.0; no other content changes.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[Install x0x CLI plus x0xd daemon] --> B[x0x start]
    B --> C{Read daemon data_dir}
    C -->|api.port| D[Dynamic API address]
    C -->|bearer token| E[Auth credential]
    D & E --> F[REST API calls]
    D & E --> G[WebSocket connection]
    F --> H[publish / subscribe / direct / MLS / tasks / stores]
    G --> I[Client sends: type subscribe, topics array]
    G --> J[Server pushes: type message, origin field]
    G --> K[Server pushes: type direct_message, sender field]
Loading

Reviews (2): Last reviewed commit: "docs: use api.port in README SSE example..." | Re-trigger Greptile

Comment thread README.md
x0x peers # Connected gossip peers
x0x presence # Online agents
x0x presence online # Online agents
x0x upgrade # Check for updates
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 x0x upgrade vs x0x upgrade --check mismatch with SKILL.md

This line lists x0x upgrade as the command to "Check for updates", while the CLI reference added to SKILL.md (line 289) uses x0x upgrade --check for the same description. If --check is a dry-run flag that prevents an automatic download/install, the two documents now describe different behaviours under the same label. One of them should be corrected to match actual CLI behaviour.

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