rust-cli / rust-cli/book

how to talk about relevant crates

Open
#158 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
1.1k
Forks
122
Avg merge
10h 37m
Merged PRs (30d)
2

Description

from: https://github.com/rust-cli/book/pull/157#discussion_r947838706

So far, we only list out crates we directly use. We might want to give more thought to how we would want t talk about relevant crates more generally.

Choices

I can see three main choices:

  1. Delegate: Don't talk about crates at all and link to other resouces.

  2. List: Just list crates without discussion of differences between crates of the same domain.

    • (Domain as in e.g. pretty-printing table crates, or argument parser crates.)
    • Con: competition with awesome-rust et al. lists / duplicated effort. (but these other lists could be assimilated/consolidated here)
    • Pro: You'd have everything in one place, i.e. if you'd wanna know/learn about CLI in Rust, this book would always be the go to resource. (which it isn't at the moment because the useful crates section is neither exhaustive nor does it discuss crates in the same domain)
  3. Discuss: List and discuss the relevant crates in their respective domain.

    • Let awesome-rust et al. be the short list version. Extend on a simple listing by discussing differences between crates in the same domain, e.g. when would I use clap over any of the other argument parsing libs out there and when would I use any of the other libs.
    • This could be organized in sub sections of Useful crates, i.e. keep the main Useful crates page as is, and add a subsection for each domain.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the linked discussion in PR #157 and the book's Useful crates section first. Done means choosing and documenting a policy—delegate, list, or discuss relevant crates—and updating the relevant book section accordingly.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
cli, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.