docs: README badges + reproduce folds; crate metadata honesty fixes - #49
Merged
Conversation
- README: add CI/crates.io/docs.rs/license badge row, an Installation section, and collapsible Reproduce folds under the Modes and Performance benchmark tables (pattern borrowed from infino's numbers-first README) - workspace keywords: replace 'no-std' with 'mobile' — vecq-core links std and has never been a no_std crate; the claim was unverifiable - vecq-core: description now reflects the width-configurable reality (it still said '4-bit' after v0.3.0 made 5-bit the default), and keywords/categories/homepage now inherit from the workspace so the next publish ships full crates.io metadata (currently empty there) No code changes. Benchmark numbers copied verbatim from docs/BENCHMARK.md.
🔍 Cora AI Code Review✅ No issues found. Code looks good! Review powered by cora-code · BYOK · MIT |
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.
What
Three documentation/metadata fixes — no code changes:
no-stdworkspace keyword (replaced withmobile). vecq-core linksstdthroughout and has never been ano_stdcrate — the keyword was an unverifiable claim sitting in the manifest.keywords,categories, andhomepagenow inherit from the workspace.Why
The crates.io listing for vecq-core currently shows empty keywords and categories — the workspace fields existed but were never wired into the crate manifest, and the next publish would have shipped the stale "4-bit" description alongside that gap. This PR makes the manifest honest and complete by construction, so the registry page produced by the next release is accurate without further work.
On the README side, the goal is credibility: every benchmark table is now followed by the exact commands that produced it, plus an honest note on what replicates everywhere (recall values, deterministic) versus what varies by host (absolute latencies).
Testing
cargo check -p vecq-core— clean.cargo publish -p vecq-core --dry-run— packages cleanly (12 files) with the new metadata resolved from the workspace.docs/BENCHMARK.md— README and BENCHMARK.md remain in agreement.