Repository navigation
docs: rewrite the readme and move internal records under docs/ - #7
Merged
Merged
Conversation
Move specs, measurement plans, and development reports from the repository root into docs/design, docs/measurements, and docs/history, and fix the links and tool paths that referenced them. Move the embedding guide to docs/embedding.md, add a changelog, a short contributing guide, a release guide, and crate-level documentation. Bump diffs-rs to 0.1.1 so crates.io shows the new readme.
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
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.
Cleans up the repository root and replaces the status-report README.
docs/design/, measurement plans todocs/measurements/(with a new summary page), and development reports and the old status log todocs/history/. All moves usegit mv; relative links, tool paths, and the Cargoincludelist are updated.docs/embedding.mdand now shows a crates.io dependency instead of a path dependency.no_rundoctest, so the snippet stays compiled in CI.diffs --helpno longer says "visual prototype".Checks run locally: fmt, clippy (default, all features, lib with no default features),
cargo docwith-D warnings, full release test suite, embedded host contract,cargo package --workspace --locked.