docs: document metadata v2.0 in README (fixes #11) - #12
Open
hiroshic9-png wants to merge 2 commits into
Open
hiroshic9-png wants to merge 2 commits into
hiroshic9-png wants to merge 2 commits into
Conversation
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.
Description
Documents metadata v2.0 in
README.mdandREADME_ja.md. The v2.0 schema has shipped ondevelopment—MetadataV2_0is nowMetadataLatest,__version__is2.0.0, andVERSION_REGISTRY/ the test suite treat"2.0"as a first-class version — but the READMEs still listed only0.0–1.3, so new users had no description of v2.0.What changed (docs-only, both English and Japanese READMEs): added
2.0to the Key Features / Version Management line; added a v2.0 row to the Supported Versions table (Stable / latest); and added a brief "What's new in v2.0" note — v1.x's nestedcontext/runare replaced by first-class top-level fields (robot,environment,runner,devices,programs,episode,labels,segments) andversionis renamed toschema_version.Fixes #11
Type of Change
Documentation update.
How Has This Been Tested?
Docs-only change — no code, schema, or tests were modified. Verified locally on
development:GIT_LFS_SKIP_SMUDGE=1 uv syncthenuv run pytest -q→ 138 passed, 2 skipped. Also rendered both READMEs in GitHub's Markdown preview to confirm the new table row and note render correctly.Checklist
Tests added/updated: N/A (docs-only; existing suite unchanged). Documentation updated, self-reviewed, and ready for review.