[meta-freescale] [Documentation][PATCH] RN: Rearrange files and restructure the sections

[Otavio Salvador]

On Wed, Nov 19, 2014 at 1:27 PM, Daiane Angolini <daiane.list at gmail.com> wrote:
> On Wed, Nov 19, 2014 at 1:19 PM, Otavio Salvador
> <otavio at ossystems.com.br> wrote:
>> On Wed, Nov 19, 2014 at 12:24 PM, Daiane Angolini
>> <daiane.angolini at freescale.com> wrote:
>>> This change does not remove any text. It only moves around targeting a
>>> better overall order. The changes are:
>>
>> I do like all the layout and organization changes you did. I think it
>> is a big improvement of what we had (and I already liked it) :-)
>
> Thanks Otavio!
>
> Do you remember when I complained about all the files and mess around
> RN? Now I´m starting to feel comfortable!

Yes; I agree. We ought to be careful to use include files for the
generated content though.

> There is no reason to have so much files! Instead, for me it makes
> sense to have one file for each "chapter" only, and the chapter must
> group only its relevant content.

+1

> My next step is to reallocate the Kernel Release Notes section (and
> maybe extend it).
>
> It´s important to keep some kernel release notes reference within the
> Scope section (only to say this is out of our scope), and maybe extend
> with external links this content near to "kernel source code" section
> under Software Architecture chapter.

+1

> Oh, other thing. Nowadays the RN online TOC has maxdepth=2 (only show
> chapter and section). I wonder if it would be beneficial to change it
> to maxdepth=3/4 (chapter, section, subsection and maybe
> sub-subsection)

We might change it to 3 in all, I think.

-- 
Otavio Salvador                             O.S. Systems
http://www.ossystems.com.br        http://code.ossystems.com.br
Mobile: +55 (53) 9981-7854            Mobile: +1 (347) 903-9750