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

It's hard to find options in the manifest reference doc #5822

Closed
kornelski opened this issue Jul 28, 2018 · 2 comments · Fixed by #7733
Closed

It's hard to find options in the manifest reference doc #5822

kornelski opened this issue Jul 28, 2018 · 2 comments · Fixed by #7733
Labels
A-documenting-cargo-itself Area: Cargo's documentation

Comments

@kornelski
Copy link
Contributor

kornelski commented Jul 28, 2018 •
edited
Loading

The manifest documentation page has grown rather large.

To find documentation about particular section or property I have to search within the page, but that's not always convenient as the keywords are mentioned in many places.

Mdbook's table of contents isn't helpful either, because it only has a single entry for the whole page and doesn't break it down by section.

  • Would it be possible to make table of contents more detailed? i.e. at least link to description of each section of the manifest, or ideally to every property?

  • If not, could this page be split? e.g. package-related and workspace-related parts separately.
@alexcrichton alexcrichton added the A-documenting-cargo-itself Area: Cargo's documentation label Jul 28, 2018
@dwijnand
Copy link
Member

I think it's a relatively recent addition, though I'm not sure if it predates 28 Jul, but Cargo docs are now searchable (by virtue of mdbook having search functionality).

Does that resolve this issue sufficiently?

Though I'm not against splitting workspace-related parts into a dedicated page.

@kornelski
Copy link
Contributor Author

kornelski commented Sep 24, 2018 •
edited
Loading

mdbook searchability would help a bit, but currently it doesn't, because there's a bug that breaks search results links: #6084

@kornelski kornelski mentioned this issue Sep 24, 2018
Closed
ehuss added a commit to ehuss/cargo that referenced this issue Dec 21, 2019
@ehuss
Add a table of contents for the manifest.
543e381 
Closes rust-lang#5822
@ehuss ehuss mentioned this issue Dec 21, 2019
Merged
bors added a commit that referenced this issue Dec 22, 2019
@bors
Auto merge of #7733 - ehuss:doc-updates, r=Eh2406
741f0e5 
Various doc updates

This is a collection of documentation updates that have been in my todo list for a while. Each change is in a separate commit.

The "features" chapter will probably get significant changes in the future, as it is pretty bare right now. Similarly the "workspace" chapter could probably use more examples.

Closes #3062
Closes #3817
Closes #3971
Closes #4212
Closes #4438
Closes #4756
Closes #5822
Closes #6913
Closes #7055
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.

Various doc updates ehuss/cargo
3 participants
@alexcrichton @kornelski @dwijnand