Re: Docs Style Guide

2019-07-18 Thread Chris Johns
> On 19 Jul 2019, at 3:09 pm, Sebastian Huber > wrote: > >> On 19/07/2019 00:23, Gedare Bloom wrote: >>> On Thu, Jul 18, 2019 at 11:35 AM Chris Johns 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 doc

Re: Docs Style Guide

2019-07-18 Thread Sebastian Huber
On 19/07/2019 00:23, Gedare Bloom wrote: On Thu, Jul 18, 2019 at 11:35 AM Chris Johns 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 S

Re: Docs Style Guide

2019-07-18 Thread Gedare Bloom
On Thu, Jul 18, 2019 at 11:35 AM Chris Johns 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,

Re: Docs Style Guide

2019-07-18 Thread Joel Sherrill
On Thu, Jul 18, 2019, 3:54 PM Gedare Bloom wrote: > On Thu, Jul 18, 2019 at 11:35 AM Chris Johns 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. > > > >

Re: Docs Style Guide

2019-07-18 Thread Gedare Bloom
On Thu, Jul 18, 2019 at 11:35 AM Chris Johns 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,

Re: Docs Style Guide

2019-07-18 Thread Gedare Bloom
On Thu, Jul 18, 2019 at 12:33 PM Joel Sherrill wrote: > On Thu, Jul 18, 2019, 12:35 PM Chris Johns 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]. [...] >> > >> > [1] >> > https://docs.rtems.org/b

Re: Docs Style Guide

2019-07-18 Thread Joel Sherrill
On Thu, Jul 18, 2019, 12:35 PM Chris Johns 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, >

Re: Docs Style Guide

2019-07-18 Thread Chris Johns
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