Skip to content

readme: add link to the cargo documentation on docs.rs #5031

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

Merged
merged 1 commit into from
Feb 12, 2018

Conversation

matthiaskrgr
Copy link
Member

Rendered

Background: I was searching for cargo source code doc a while back, found the cargo book and crates.io doc relatively quickly but not the actual source code doc which I only found (after way to much time had passed) when I looked up the cargo crate on crates.io and found the "Documentation" link :/

Hope this improves the situation a bit in the future.

@rust-highfive
Copy link

r? @matklad

(rust_highfive has picked a reviewer for you, use r? to override)

@matklad
Copy link
Member

matklad commented Feb 12, 2018

Hm, what about moving it to CONTRIBUTING.md or ARCHITECTURE.md? I think README.md, at least in theory, is more targeted on the users of Cargo, and they may be confused by this, especially if they are new to Rust

@matthiaskrgr
Copy link
Member Author

Hmm, good point.
On the other hand, I assume that most people that view the readme do so on github or after having cloned the repo, and most people who clone the repo are probably somewhat interested in also modifying its code.

Also I have to admit that when searching for the code docs, I did not even consider looking into CONTRIBUTING.md or ARCHITECTURE.md so that would not have helped at least in my case :/

@matklad
Copy link
Member

matklad commented Feb 12, 2018

Hm, I have no particularly strong feeling either way here, so let's

r? @alexcrichton

:)

@alexcrichton
Copy link
Member

Perhaps this could be placed under "Code status" and hopefully that'll scope it well enough?

@matthiaskrgr
Copy link
Member Author

Sounds good, updated.

@alexcrichton
Copy link
Member

@bors: r+

@bors
Copy link
Contributor

bors commented Feb 12, 2018

📌 Commit ddffe60 has been approved by alexcrichton

@bors
Copy link
Contributor

bors commented Feb 12, 2018

⌛ Testing commit ddffe60 with merge 40486ce...

bors added a commit that referenced this pull request Feb 12, 2018
readme: add link to the cargo documentation on docs.rs

[Rendered](https://github.com/matthiaskrgr/cargo/blob/readme_docs/README.md)

Background: I was searching for cargo source code doc a while back, found the cargo book and crates.io doc relatively quickly but not the actual source code doc which I only found (after way to much time had passed)  when I looked up the cargo crate on crates.io and found the "Documentation" link :/

Hope this improves the situation a bit in the future.
@bors
Copy link
Contributor

bors commented Feb 12, 2018

☀️ Test successful - status-appveyor, status-travis
Approved by: alexcrichton
Pushing 40486ce to master...

@bors bors merged commit ddffe60 into rust-lang:master Feb 12, 2018
@matthiaskrgr matthiaskrgr deleted the readme_docs branch September 6, 2018 15:01
@ehuss ehuss added this to the 1.25.0 milestone Feb 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants