doc: Add README for shared, and link READMEs in the crates#175
Merged
geonnave merged 1 commit intolake-rs:mainfrom Dec 13, 2023
Merged
doc: Add README for shared, and link READMEs in the crates#175geonnave merged 1 commit intolake-rs:mainfrom
geonnave merged 1 commit intolake-rs:mainfrom
Conversation
geonnave
reviewed
Dec 13, 2023
| version = "0.4.1" | ||
| repository = "https://github.com/openwsn-berkeley/edhoc-rs/" | ||
| license = "BSD-3-Clause" | ||
| readme = "shared/README.md" |
Collaborator
There was a problem hiding this comment.
why it points to the README of the shared crate?
Collaborator
|
Thank you for this PR, it looks good. Left one minor comment. |
Member
Author
|
why it points to the README of the shared crate?
Because it fast-forwards the user to the relevant main crate with the
overview documentation. Several crates with all the same text (and the
user won't know unless they diff, maybe the detail is somewhere down)
are confusing to users. The shared README is ... well, shared among all
other crates :-) and is just that: a pointer that says it's part of the
big thing.
|
Collaborator
|
I see, then it can just be overridden when crate-specific READMEs are added. Cool! |
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.
This should fix the big looming "appears to have no README.md file" texts on crates.io. I don't think we can really test this other than wait what it looks like after the next release, but the absense of "unused manifest key" warnings in a cargo check is a good sign.
The main crate just uses the top-level README; all others use a shared one that points to the main crate.