[Workflow] A protocol to review the documentation is not in place yet

[Bachibouzouk]

Ideas:

• when commenting on things: add a comment within the .rst file (with .. leading the text), so that it appears in a PR, we can then discuss in the PR, then remove the comments before merging the PR
• when you see misformatting in the docs, you can either propose a fix (if you know how), or simply take a screenshot and open an issue

Please collect further ideas in this issue, then we'll formalize what worked well in a protocol :)

[srhbrnds]

I am a bit unsure, when to take a screenshot in case of misformatting e.g. in the view-components, I see different formatting of the properties items. Can you explain in brief, why it makes sense to take a screenshot instead of proposing the change directly in the code and open a pull request? Thanks!

[Bachibouzouk]

I am a bit unsure, when to take a screenshot in case of misformatting e.g. in the view-components, I see different formatting of the properties items. Can you explain in brief, why it makes sense to take a screenshot instead of proposing the change directly in the code and open a pull request? Thanks!

Thank @srhbrnds , I would say
If you can fix directly, then fix directly.
If you don't know how to fix but want to raise the issue screenshot, then use screenshots.