docs: bring documentation current (ABI v8 / 75 handlers); trim to two flagship examples#22
Merged
Merged
Conversation
Documentation pass to match the project as it stands (ABI v8, 75 public handlers) and slim the examples to the two flagship demos. Examples: - Remove the three minimal single-concept demos: torrent-demo, torrent-dht-note, torrent-dht-channel. Keep the full client (torrent-client), the decentralized DHT demo (torrent-dht-channels), and the shared poll-dispatcher utility (torrent-helpers); both flagships are self-contained and run without the helper. - package-extension.py now stages the binding + helpers + both flagship demos (it had bundled the now-removed torrent-demo and omitted the flagships). Docs: - README: Features rewritten to cover the v4-v8 surface (queue, flags/modes, move-storage, scrape, caps, file table, per-piece availability, trackers, web seeds, session ops, IP filter, streaming deadlines, extended add); Examples list trimmed to the two flagships + helpers; Status notes the 75-handler / ABI v8 breadth. API-at-a-glance table already current (75). - getting-started: drop references to the removed torrent-demo (the skeleton is presented standalone; it points at the two flagship examples instead). - architecture: add the channels demo to the stack diagram; list the new file/tracker/availability getters among the out-buffer crossings. - implementation-plan: fix the examples file tree. Verified: api-reference documents all 75 public handlers (coverage checked); no dangling references to the removed files anywhere in the repo; check-livecodescript passes (4 files); package-extension.py parses. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01371AXB4CUUke7enHHS8okc
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
2 participants
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.
A documentation pass to match the project as it now stands (ABI v8, 75 public handlers) and slim the examples to the two flagship demos.
Examples
torrent-demo,torrent-dht-note,torrent-dht-channel.torrent-client), the decentralized DHT demo (torrent-dht-channels), and the shared poll-dispatcher utility (torrent-helpers). Both flagships are self-contained and run without the helper.tools/package-extension.pynow stages the binding + helpers + both flagship demos — it had bundled the now-removedtorrent-demoand omitted the flagships entirely.Docs
torrent-demo; the lifecycle skeleton is presented standalone and points at the two flagship examples.Verification
torrent.lcb).check-livecodescriptpasses (now 4 files =torrent.lcb+ the 3 kept scripts);package-extension.pyparses.🤖 Generated with Claude Code
https://claude.ai/code/session_01371AXB4CUUke7enHHS8okc
Generated by Claude Code