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

[book] Add a Glossary section? #4392

Closed
behnam opened this issue Aug 10, 2017 · 2 comments · Fixed by #6321
Closed

[book] Add a Glossary section? #4392

behnam opened this issue Aug 10, 2017 · 2 comments · Fixed by #6321
Labels
A-documenting-cargo-itself Area: Cargo's documentation C-enhancement Category: enhancement

Comments

@behnam
Copy link
Contributor

behnam commented Aug 10, 2017

What terms are used in Cargo and what they mean is a common theme in Cargo issues/pulls, as well as in the documentation. Recently I just updated some of the docs to use the correct term in their place. (See #4376 and #4375)

I think with the expansion of Cargo features, it makes sense to have a Glossary document that describes each term and points to the detailed description.

We can add this to the new mdBook-based docs, and not in-repo.

Here's some example terms that I have seen confusions about in the docs and public spaces, like the users forum:

  • crate
  • package
  • build target (as in platform and its binary format)
  • target (as in lib, bins, tests, examples, ...)
  • crate file
  • package repository (as in git repo)
  • package registry (as in crates.io), a.k.a. package index
  • package root (the directory)
  • workspace root (the directory)
  • workspace root package (a package or its manifest)
  • repository root (the directory)

What do you think?

@alexcrichton alexcrichton added the A-documenting-cargo-itself Area: Cargo's documentation label Aug 10, 2017
@alexcrichton
Copy link
Member

cc @carols10cents

@behnam
Copy link
Contributor Author

behnam commented Aug 10, 2017

Also cc @istankovic, since this would be a new section on the new mdBook-based repo.

@carols10cents carols10cents added the C-enhancement Category: enhancement label Aug 27, 2017
@behnam behnam changed the title [docs] New Glossary doc? [book] Add a Glossary section? Sep 28, 2017
@ehuss ehuss mentioned this issue Nov 16, 2018
bors added a commit that referenced this issue Nov 17, 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 C-enhancement Category: enhancement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants