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.

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

Jump to bottom

Merge "how to use crates.io" into the Guide #1035

Closed
steveklabnik opened this issue Dec 11, 2014 · 1 comment · Fixed by #2688
Closed

Merge "how to use crates.io" into the Guide #1035

steveklabnik opened this issue Dec 11, 2014 · 1 comment · Fixed by #2688
Labels
A-documenting-cargo-itself Area: Cargo's documentation

Comments

@steveklabnik
Copy link
Member

It's weird that http://doc.crates.io/crates-io.html is separate from the Guide, all hidden away. It should really become part of that.
@steveklabnik steveklabnik added the A-documenting-cargo-itself Area: Cargo's documentation label Dec 11, 2014
@huonw huonw mentioned this issue Jan 17, 2015
Closed
@parkr
Copy link
Contributor

parkr commented Jan 17, 2015

Yoooooo huge 👍 to that. My impassioned (but brief) letter in rust-lang/crates.io#117. Let me know if I can help at all in this endeavour, @steveklabnik.

@parkr parkr mentioned this issue Jan 17, 2015
Merged
carols10cents added a commit to carols10cents/cargo that referenced this issue May 13, 2016
@carols10cents
Incorporate "using crates from crates.io" into the main guide
1364b62 
Connects to rust-lang#1035. Using crates from crates.io is a
common thing that many people will want to know how to do right away and
deserves to be part of the main guide.
@carols10cents carols10cents mentioned this issue May 13, 2016
Merged
bors added a commit that referenced this issue May 18, 2016
@bors
Auto merge of #2688 - carols10cents:docs-refresh, r=alexcrichton
33e1797 
Docs refresh

Hi! Sooooo I've been thinking about the cargo docs lately and today I decided to try some of the things I've been thinking about.

There are some smaller changes in here, typos and clarifications and stuff, that I'm totally willing to break out into a separate PR(s) if yinz want.

My goals for the larger changes were:

- **Make one obvious place to go for info on every which way to specify a dependency.** I've found myself clicking around the different doc pages a lot to find the semver syntax, the different keys that can go with a git location, the `path` override syntax, etc. So I made one top-level "Specifying Dependencies" page and moved relevant info from the guide, the manifest page, and the crates.io page.
- **Make The Guide a bit more focused.** There were a few topics in there that didn't really fit in the story arc of trying to get someone up and running with cargo-- it veered off into some more advanced topics that I've moved to places I think they fit better.
- **Make the crates.io page only about publishing, not using and publishing.** The info about adding dependencies got folded into either the guide or the new specifying dependencies page, so this should close #1035.

I'm also thinking about having someone new to rust/cargo try following the guide, but wanted to get a first pass from experienced people :)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-documenting-cargo-itself Area: Cargo's documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Docs refresh carols10cents/cargo
2 participants
@steveklabnik @parkr