search

justwriteclick / docslikecode

Read stories, learn through practice, share with others, to treat docs as code.
https://www.docslikecode.com
MIT License
45 stars 15 forks source link

Typos in the Third Edition of Docs Like Code #243

Open xanderstevenson opened 3 months ago

xanderstevenson commented 3 months ago

Hi,

Excellent book and project!

Anne G. said I could leave the typos I found (or think I found) in the Third Edition, November 2022, soft-cover book here:

Page 21, at the top....should be "technical documentation, serves"

Page 22, under 'containers'....the letters/words in the first two lines are all scrunched together.

Page 31, at the bottom...should be "requirements: security-related companies"

Page 108, the last two paragraphs are essentially restated in the two bullet points at the top of page 110, prefaced by "You can also use the docs version parameter to". It seems redundant, and contradicts the prefacing, which suggests that something new is being introduced. Perhaps removing the word "also" in the prefacing would suffice in making things clearer, as it will then be indicating the (re)stating of important points follows.

github-actions[bot] commented 3 months ago

Thanks for logging an issue for the docslikecode.com website. If you would like to fix it yourself, that's fine. Assign yourself and send in a PR. You can also log issues with the book, Docs Like Code, and the author will see them here.

annegentle commented 3 months ago

Good eyes, Alex! Page 22 especially looks strange. I appreciate you taking the time to send these. I'll get in touch with the graphic designer who did the PDF layout for corrections. 👍