Skip to content

Fix - README section to match Cargo readme behavior #3109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
syphar merged 1 commit into from
Dec 30, 2025
Merged

Fix - README section to match Cargo readme behavior #3109

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions templates/core/about/builds.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,9 @@ <h3 id="notes-on-docsrs"> <a href="#notes-on-docsrs">Notes on using Docs.rs</a>

<h4 id="setting-a-readme"> <a href="#setting-a-readme">Setting a README</a> </h4>
<p>
The README of a crate is taken from the <code>readme</code> field defined in
<code>Cargo.toml</code>. If this field is not set, no README will be displayed.
The README displayed on docs.rs follows Cargo’s <code>package.readme</code> rules.
If <code>readme</code> is not set, docs.rs will look for <code>README.md</code>, <code>README.txt</code>, or <code>README</code> in the crate root.
Set <code>readme = "path/to/file"</code> to use a custom file, <code>readme = true</code> to use <code>README.md</code>, or <code>readme = false</code> to disable the README.
</p>

<h4 id="detecting-docsrs"> <a href="#detecting-docsrs">Detecting Docs.rs</a> </h4>
Expand Down
Loading