Proofreading fixes

[SergioGasquez]

Thanks @f-hollow for all the suggestions.

Regarding IDEs:

I read this paragraph and immediately have a question why only VS Code is covered?

Does this tool have a better support? Is it a personal preference of the authors?

We only cover VsCode as it's the most used IDE. In the past we had subsections for other IDEs, but they were very short and didn't provide much, so we decided to get rid of them.

Regarding debugging chapter comments:

As I see the table, I immediately have a question: If openOCD and VS Code support all chips, then why bother with probe-rs?

Are there any advantages to it? Should they be mentioned in the introduction or are they obvious to the target audience?

How openOCD and VS Code are different and why we need both?

I added an entry for this in #105

I see that the subsections mention certain chips. Does it mean that other chips do not require any actions on the part of the user?

Should it be mentioned anywhere?

I added an entry for this in #105

[SergioGasquez]

Here I address some of your comments/suggestions

[f-hollow]

@SergioGasquez

We only cover VsCode as it's the most used IDE. In the past we had subsections for other IDEs, but they were very short and didn't provide much, so we decided to get rid of them.

Suggest briefly mentioning this:

We chose VS Code because it has better support for Rust and is more popular. However, you can use other IDEs....

[f-hollow]

There is also one comment about the Tips and Tricks section in /src/tooling/text-editors-and-ides.md

Looks like this section contains two tips:

• Issue with std and Rust Analyzer
• Custom toolchain and Cargo hints

Suggest splitting "Tips and Tricks" into two sections. As these sections relate to VS Code, suggest turning them into subsections VS Code.

[f-hollow]

The only comment that we did not cover is about the word ecosystem in "Ecosystem Overview."

The Ecosystem Overview chapter seems to cover the std and no_std development approaches. Can it be called an ecosystem? How about "Overview of Development Approaches" or something else?

[f-hollow]

Thank you for implementing my suggestions. Now only a few small things left.

[SergioGasquez]

Suggest briefly mentioning this:

We chose VS Code because it has better support for Rust and is more popular. However, you can use other IDEs....

Suggest splitting "Tips and Tricks" into two sections. As these sections relate to VS Code, suggest turning them into subsections VS Code.

Both things should be fixed in 2cf23e4

[SergioGasquez]

The Ecosystem Overview chapter seems to cover the std and no_std development approaches. Can it be called an ecosystem? How about "Overview of Development Approaches" or something else?

Updated!

[f-hollow]

@SergioGasquez

The following steps might be (in this or separate PRs):

1. (Optional) Ask others to review the current updates.
2. Lint the content using Vale linter.
   • The configuration files are in idf/esp-vale-config
   • As I haven't written the instructions yet, suggest having a call to discuss how to use Vale
3. Update file names and folder names in src/
   • Some names are outdated, so it is not easy to navigate inside src/
   • Consider also adding chapter numbers in file/folder names to arrange items in the order the book uses them

[SergioGasquez]

Just pushed 1b9e9be updating file names and folder names in src/and adding some redirections from old paths to new paths, so we maintain backward compatibility and do not break links pointing to the book. We already did break some links in the past, see esp-rs/esp-idf-template#137 for example.

With these redirections #72 can be also closed when this is merged.

Adding numbers to the folder/file names will require adding a lot of redirections, and if we include/remove a chapter in the future, it will include a lot more redirections, for this reason I would prefer not to include them.

[f-hollow]

@SergioGasquez

Did another review and came up with a few more nitpicks. This is the last batch from me.

I uploaded a file with comments in Code Review format on mattermost.

The book looks great!

P.S. Just discovered that I can also attach files here. It is even more convenient.

code-review.csv
code-review.csv.md

[SergioGasquez]

@SergioGasquez

Did another review and came up with a few more nitpicks. This is the last batch from me.

I uploaded a file with comments in Code Review format on mattermost.

The book looks great!

P.S. Just discovered that I can also attach files here. It is even more convenient.

code-review.csv code-review.csv.md

Just addressed all your comments/suggestions

[f-hollow]

@SergioGasquez

Thank you for implementing all the suggestions! One thing: You fixed the issue with the unnecessary scroll bar in the code snippet in Understanding esp-template. Please do the same in Understanding esp-idf-template.

Now that you have formatted the notes and warnings according to the Rust Documentation Style Guide, the book looks as official as all other Rust books.

[SergioGasquez]

Thank you for implementing all the suggestions! One thing: You fixed the issue with the unnecessary scroll bar in the code snippet in Understanding esp-template. Please do the same in Understanding esp-idf-template.

Good catch! Fixed.