Docs Style Guide
gedare at rtems.org
Thu Jul 18 22:23:44 UTC 2019
On Thu, Jul 18, 2019 at 11:35 AM Chris Johns <chrisj at rtems.org> 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 .
> Thank you for raising this.
> > We should start to collect Documentation Style notes in a wiki page,
> > and then push it to the docs . If anyone has some initial set of
> > thoughts, it would be good to put them down in reply to this email.
> We do have https://git.rtems.org/rtems-docs/tree/README.txt#n393.
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?
More information about the devel