Add missing crate READMEs and other cleanup #458
Merged
Conversation
This file contains 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
* Adds READMEs for the `libcnb-data` and `libcnb-proc-macros` crates, since previously they were bundling the repo root README, which was confusing when looking at their crates.io listing (#274). * Corrects the MSRV listed in the READMEs so it matches that defined in each crate's `Cargo.toml` after #445. * Adds badges to READMEs that didn't have them, to improve discoverability of the docs (eg towards #402) and awareness of latest version of each crate. Note: `libcnb-cargo` does not have a docs link since it's a binary not a library. * Syncs the `libcnb-cargo` usage example output with the latest output used in the repo root README. * Switches the docs.rs URLs style from `/*/` to `/latest/` since the former resolves to an exact version, which if bookmarked (or search engine indexed) will get out of date. * Various other small tweaks. Fixes #274. Addresses part of #402.
edmorley
added
documentation
Malax
approved these changes
Jul 7, 2022
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.
libcnb-dataandlibcnb-proc-macroscrates, since previously they were bundling the repo root README, which was confusing when looking at their crates.io listing (Use a separate README for libcnb-data and libcnb-proc-macros #274).Cargo.tomlafter Strip buildpack binaries when packaging #445.libcnb-testdocs on docs.rs #402) and awareness of latest version of each crate. Note:libcnb-cargodoes not have a docs link since it's a binary not a library.libcnb-cargousage example output with the latest output used in the repo root README./*/to/latest/since the former resolves to an exact version, which if bookmarked (or search engine indexed) will get out of date.Fixes #274.
Addresses part of #402.
GUS-W-11395978.