Repository navigation
Give every published crate its own README, release 0.0.2 - #788
Merged
Merged
Conversation
In 0.0.1 only zudb and zudb-cli had a readme, and both showed the repository README, so the twelve zudb-* pages on crates.io were empty. Each crate now has a README.md next to its Cargo.toml saying what it does and that most people want zudb. The zudb README carries the quickstart, and the snippet test checks that copy as well. Bumps the workspace and the exact pins to 0.0.2, with the generated model.json and conformance.toml following the version. Closes #787
…to use it Every example in these READMEs was compiled against the crate it describes. The zudb examples are programs in zu-snippets, and the readme test now checks each README against its own snippet list and runs the new ones.
…lite README The Homebrew formula and Scoop manifest are rendered from the version, so the bump has to carry them, and the terms check wants optimizer where the sqlite README said planner.
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.
Every crate on crates.io now gets a README of its own. In 0.0.1 the twelve zudb-* pages were empty, and zudb and zudb-cli showed the repository README.
readmeat that file.crates/zu-snippets/tests/readme.rsnow checks that copy against the example program as well.docs/api/model.jsonandconformance.toml.Closes #787