[PATCH rtems-docs v2 1/2] Added FAQ page

[Ayushman Mishra]

Using "-----" makes H4 size headings
(https://documentation-style-guide-sphinx.readthedocs.io/en/latest/style-guide.html#headings).

Could there be a single FAQ section and then internal references, ie
links? : Does it mean making separate .rst pages for each question
(whose answers were previously written in faq page) and the reader
will only see hyper-link questions , and regarding cross-link
questions written single line example: " Please refer section
"Creating a Patch" of RTEMS Software Engineering manual in
https://docs.rtems.org/ ".

On Sun, Apr 4, 2021 at 7:34 AM Chris Johns <chrisj at rtems.org> wrote:
>
> On 4/4/21 10:37 am, Ayushman Mishra wrote:
> > Sir, can you please clarify a little bit what does "each question needs to be a
> > section heading of some level" mean , because sir I have used  this "-----" line
> > below every question which is a symbol used for showing the sentence as a
> > heading in sphinx document and after building the questions are automatically
> > shown as 2.10.1, 2.10.2 ... (upto total questions).
>
> Oh yes it does. Sorry about that.
>
> Hmmm what does this do to the size of the table of contents for HTML and PDF?
>
> I have shortened the length of section headers in the past to remove words that
> are not needed to make the columns and TOCs a manageable width.
>
> I am not sure how this could handled in this context with these questions?
>
> Could there be a single FAQ section and then internal references, ie links?
> Internal links are ok. And also a link back to the question list after each
> question?
>
> Chris
>