docs: refresh README banner and fix stale counts#13
Draft
slavazeph-coder wants to merge 4 commits into
Draft
Conversation
- Update docs/assets/crumb-banner.svg from 0.2.0 → 0.4.0, add v=1.2 wire-format callout, and swap the "41 commands" badge for 44. - Show a v1.2 CRUMB on the banner (refs, fold, handoff) so the image reflects what the README now advertises. - README: 41 / 41+ command counts → 44 (three places), and update the "crumb it" cheat sheet default to v=1.2 (v=1.1 noted as still valid). - Correct "Five kinds" → "Six kinds" to include `wake` per SPEC §4.6.
Contributor
CRUMB Bench Results
Powered by crumb-format — two-stage context compression |
Contributor
✅ Shadow AI ScanNo Shadow AI findings detected at or above medium risk. |
Two related fixes so `bench-pr.yml` stops reporting N/A for legitimate CRUMBs on this repo's own PRs: 1. `pip install .` when running on a checkout of crumb-format itself (detected via pyproject.toml `name = "crumb-format"`), otherwise fall back to `pip install crumb-format` for the reusable workflow_call path. Before this, PRs that bump the wire format (e.g. 0.4.0 → v=1.2) were benched against the last-published PyPI version (0.3.0), which rejects v=1.2 and yields `N/A` for every v1.2 example. 2. Add `-type f` to the `find` invocation. The `.crumb/` session-state directory matched `*.crumb` and was benched as a file, producing an IsADirectoryError and a noisy `N/A` row. Mirror the change into the self-contained template for consistency.
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.
Summary
The README banner (
docs/assets/crumb-banner.svg) was last updated at v0.2.0, so it still advertised "CRUMB 0.2.0" and "41 commands" while the repo is on v0.4.0 /v=1.2with 44 CLI commands — which made the hero image read as missing/stale. Fixed that and swept the rest of the README for the same drift.docs/assets/crumb-banner.svg:0.2.0→0.4.0, add awire format v=1.2callout, bump the command badge to 44, and show a v1.2 CRUMB on the banner (refs + fold + handoff) so the image matches what the README now advertises.v=1.2(with a note that v=1.1 is still valid — v1.1 parsers accept v1.2).wakeperSPEC.md §4.6.No functional code changes — docs + image only.
Test plan
cmd_*functions incli/crumb.pySPEC.md §4.1–§4.6