usage of `cat` is not helpful for reader

Open Beginner friendly
#137 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
62/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
linux, shell

Research direction

Open src/intro/install/linux.md at the udev-rules section and review the instructions around /etc/udev/rules.d/70-st-link.rules. Clarify the file name and how its contents are created, using one of the suggested approaches. Done means a reader can tell which file to create and what command or editor step to use.

Written by the indexing model from the issue text.

Description

Here https://github.com/rust-embedded/book/blob/aadfc95f85e635c6a37a7b12ae9255fd39b08b36/src/intro/install/linux.md#udev-rules

Create this file in /etc/udev/rules.d with the contents shown below.

this is not referring to something the reader has already read. It's not good in english to refer to it or this before it was mentioned. Further cat /etc/udev/rules.d/70-st-link.rules should not be the contents of the file (obviously).

Suggested fix 1:

Create the file /etc/udev/rules.d/70-st-link.rules with the contents shown below.

Suggested fix 2:
Provide a command (cat + heredoc into file?) to write the file in one go

Suggested fix 3:
provide a command to open an editor

Dominant language
No language data
Stars
1.3k
Forks
223
PR merge metrics
No merged PRs in 30d

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.

More from rust-embedded/book

All issues in rust-embedded/book

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.