SHA-12: slim README; move capability boundary to docs - #59
Conversation
- Add docs/CAPABILITY_BOUNDARY.md as the source of truth for Supported/ Partial/Not-supported claims, validation levels, and encode policies (checked against current code: FILE_TYPE Activity/Workout/Course, ProfileScope CORE/DOMAIN/FULL, EncodeMode PRESERVE/CANONICAL). - Slim README to install, public API, and minimal examples. - Point design-doc and epic release notes at the new capability doc. Co-authored-by: multica-agent <github@multica.ai>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 0a311076d9
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| Optional profile regeneration (maintainers only): | ||
|
|
||
| ```bash | ||
| uv add 'fit-tool[gen]' # openpyxl, inflection, jinja2 |
There was a problem hiding this comment.
For maintainers running this from a repository checkout, uv add 'fit-tool[gen]' fails because the requirement name matches the current project and uv rejects self-dependencies, so the documented two-command regeneration procedure cannot reach gen-profile. Use the repository's uv sync --group dev or uv sync --extra gen setup here, reserving uv add for consumers of the published package.
AGENTS.md reference: AGENTS.md:L34-L38
Useful? React with 👍 / 👎.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #59 +/- ##
=======================================
Coverage 92.72% 92.72%
=======================================
Files 36 36
Lines 2721 2721
Branches 461 461
=======================================
Hits 2523 2523
Misses 117 117
Partials 81 81 ☔ View full report in Codecov by Harness. |
1 participant
Summary
README.mdintodocs/CAPABILITY_BOUNDARY.md.IMPLEMENTED_FILE_TYPES,ProfileScope,EncodeMode,SDK_VERSION=21.205.0).Related Multica SHA-12 docs hygiene after Stage 5.
Test plan
from fit_tool import FitFile, EncodeMode, ProfileScope, SDK_VERSION