Skip to content
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.

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

Add "readme" documentation to docs.crates.io #4620

Closed
alfiedotwtf opened this issue Oct 15, 2017 · 2 comments
Closed

Add "readme" documentation to docs.crates.io #4620

alfiedotwtf opened this issue Oct 15, 2017 · 2 comments
Labels
A-documenting-cargo-itself Area: Cargo's documentation

Comments

@alfiedotwtf
Copy link
Contributor

I can't seem to find any documentation on the "readme" config item in Cargo.toml (which is a link to the file used to display on the crate's page on crates.io)... the only way I found out which setting to add in order to get the README.md to render on my crate's page was to copy what others have done...

This issue is to make this a bit clearer in crates.io's docs.

@alexcrichton alexcrichton added the A-documenting-cargo-itself Area: Cargo's documentation label Oct 15, 2017
bors added a commit that referenced this issue Oct 26, 2017
Fix documentation for package.readme option.

Fix for #4620.
@stale
Copy link

stale bot commented Sep 20, 2018

As there hasn't been any activity here in over 6 months I've marked this as stale and if no further activity happens for 7 days I will close it.

I'm a bot so this may be in error! If this issue should remain open, could someone (the author, a team member, or any interested party) please comment to that effect?

The team would be especially grateful if such a comment included details such as:

  • Is this still relevant?
  • If so, what is blocking it?
  • Is it known what could be done to help move this forward?

Thank you for contributing!

(The cargo team is currently evaluating the use of Stale bot, and using #6035 as the tracking issue to gather feedback.)

If you're reading this comment from the distant future, fear not if this was closed automatically. If you believe it's still an issue please leave a comment and a team member can reopen this issue. Opening a new issue is also acceptable!

@stale stale bot added the stale label Sep 20, 2018
@ehuss
Copy link
Contributor

ehuss commented Sep 20, 2018

This appears to be fixed by #4644.

@ehuss ehuss closed this as completed Sep 20, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documenting-cargo-itself Area: Cargo's documentation
Projects
None yet
Development

No branches or pull requests

3 participants