symlink the root README in crates so that crates.io shows it #4191
Conversation
|
I've assigned @valentinewallace as a reviewer! |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4191 +/- ##
=======================================
Coverage 88.85% 88.86%
=======================================
Files 180 180
Lines 137863 137876 +13
Branches 137863 137876 +13
=======================================
+ Hits 122496 122521 +25
+ Misses 12561 12553 -8
+ Partials 2806 2802 -4
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| @@ -0,0 +1 @@ | |||
| ../README.md No newline at end of file | |||
There was a problem hiding this comment.
FWIW, the approach AI is recommending to me is to add the "readme" field to our Cargo.tomls in each crate with a symlink to the top-level README.md. Don't think it matters much though as long as this works for crates.io
There was a problem hiding this comment.
Oh, sure, that's better.
|
👋 The first review has been submitted! Do you think this PR is ready for a second reviewer? If so, click here to assign a second reviewer. |
`crates.io` will show any README/README.md which apears in the crate which is uploaded, but it doesn't consider the README from the workspace, only if its in the crate itself. Instead, add the `readme` field so that the workspace README also gets uploaded.
TheBlueMatt
force-pushed
the
2025-10-readme-in-crates
branch
from
778240e to
1605291
Compare
|
Switched to |
|
Backported to 0.2 in #4193 |
3 participants
crates.iowill show any README/README.md which apears in the crate which is uploaded, but it doesn't consider the README from the workspace, only if its in the crate itself. Thus, we symlink the top-level README in all our crates in the hopes that it works.