docs: restructure README around one section per capability - #41
Merged
Conversation
One top-level section per capability. Hand tracking absorbs its stranded subtopics (Output schema, Raw EgoDex releases, the install-extras paragraph, and the walkthrough from Example); the generic scaffold/uvx guidance moves to a new The CLI section. Body text is byte-identical - only heading lines changed. Part of #40
- intro names hand tracking, reward scoring, and motion trimming; UDF claim widened to UDFs and expressions since trimming decodes nothing - hand-tracking opener names track_hands instead of 'the package' - Reward scoring and Motion trimming get their own Example subsections, mirroring examples/README.md - The CLI section lists all three subcommands (was 'hands and rewards so far') and opens with the subcommand overview instead of the uvx sentence that used to trail a bash block - package docstring in __init__.py gets the same update Part of #40
The intro install line drops the mediapipe extra - extras are hands-specific and documented in that section; rewards and trim need none. 'Inference stack' becomes 'runtime deps' since the trim demo runs no inference. Part of #40
Contributor/release process, not user-facing API docs. Wording unchanged; the README's Development section points there. Part of #40
ykdojo
marked this pull request as ready for review
July 31, 2026 16:41
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
1 participant
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.
Fixes #40.
The README grew one capability at a time and the structure drifted:
## APIcovered only hand tracking, its subtopics (Output schema,Raw EgoDex releases, the install-extras paragraph) were stranded as top-level siblings, and## Examplewas singular, hands-only, and stale ("hands and rewards so far").Commits are staged so the restructure is verifiable on its own:
##per capability (Hand tracking, Reward scoring, Motion trimming), each self-contained; hand tracking absorbs its schema, EgoDex reader, extras paragraph, and walkthrough as###subsections; the generic scaffold/uvx guidance moves to a new## The CLIsection. Body text is byte-identical (verified by sorted-line diff) - only heading lines changed.### Examplesubsections mirroringexamples/README.md; The CLI lists all three subcommands; the package docstring in__init__.pygets the same update.The repo About section (description, homepage, topics) was updated alongside, outside the commit history.