Attention is currently required from: Nikolai Artemiev.
Anastasia Klimchuk has posted comments on this change by Anastasia Klimchuk. ( https://review.coreboot.org/c/flashrom/+/82649?usp=email )
Change subject: doc: Convert ME and Intel docs ......................................................................
Patch Set 1:
(1 comment)
File doc/user_docs/management_engine.rst:
PS1:
Does the coding style guidelines apply to documentation as well?
That's an interesting question! :)
I can tell you what the current state is.
Major usage for reading docs is on the website. For the website, html is generated from .rst file, and line length doesn't matter. To mark new paragraph, you need to add two line breaks. So in other words, whether line length is 80 or 112 or 200 will produce the same html page.
However there is still the way to read docs from the source. GitHub web UI, where we have mirror, by default formats .rst files for preview, so line length again doesn't matter. If you look at raw source, then you have the length of your screen. And lastly, one can read or modify docs from source in the terminal window (I do this often :D ). I usually try make line length so that it's convenient to display in the medium-size laptop screen. So, not too long. But there is no strict reason to limit docs sources to 80 chars, it would leave half screen empty.
In any case, thank you so much for review! Also yes, we can improve docs further as a follow-up.
-
Anastasia Klimchuk (Code Review)