Docs Style Guide

Chris Johns chrisj at
Fri Jul 19 06:41:04 UTC 2019

> On 19 Jul 2019, at 3:09 pm, Sebastian Huber <sebastian.huber at> wrote:
>> On 19/07/2019 00:23, Gedare Bloom wrote:
>>> On Thu, Jul 18, 2019 at 11:35 AM Chris Johns<chrisj at>  wrote:
>>>> On 19/7/19 1:32 am, Gedare Bloom wrote:
>>>> Reviewing the BB doc patch, I realized that we need a style guide for
>>>> writing docs [1].
>>> Thank you for raising this.
>>>> We should start to collect Documentation Style notes in a wiki page,
>>>> and then push it to the docs [1]. If anyone has some initial set of
>>>> thoughts, it would be good to put them down in reply to this email.
>>> We do have
>> Would it be OK if we refactor the README to move some of this to the
>> SwE document, and link/reference to it from the README?
> I had this also on my TODO list, the Sphinx guide should move to the SwE and a reference to it should be added to the README.



More information about the devel mailing list