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

2021-04-04 Thread Chris Johns
On 4/4/21 1:30 pm, Ayushman Mishra wrote: > 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

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

2021-04-03 Thread 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

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

2021-04-03 Thread Chris Johns
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 >

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

2021-04-03 Thread Chris Johns
On 4/4/21 10:55 am, Ayushman Mishra wrote: > And sir , Chris is fine. I appreciate you using a formal name but in RTEMS there is no need. You are welcome here as a member of the community just like me. :) > if we can't use cross-link should I write a sentence like > for eg. " (Please refer

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

2021-04-03 Thread Ayushman Mishra
And sir , if we can't use cross-link should I write a sentence like for eg. " (Please refer section 6.1.12. "Creating a Patch" of RTEMS Software Engineering manual in :r:url:`docs`) for question How do I make a patch? " On Sun, Apr 4, 2021 at 5:05 AM Chris Johns wrote: > > > > On 3/4/21 6:25 am,

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

2021-04-03 Thread Ayushman Mishra
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

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

2021-04-03 Thread Chris Johns
On 3/4/21 6:25 am, Gedare Bloom wrote: > On Fri, Apr 2, 2021 at 12:19 PM Ayushman Mishra > wrote: >> >> --- >> user/bld/index.rst | 2 + >> user/overview/index.rst | 2 + >> user/start/faq.rst | 295 +++ >>

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

2021-04-02 Thread Joel Sherrill
On Fri, Apr 2, 2021 at 2:26 PM Gedare Bloom wrote: > On Fri, Apr 2, 2021 at 12:19 PM Ayushman Mishra > wrote: > > > > --- > > user/bld/index.rst | 2 + > > user/overview/index.rst | 2 + > > user/start/faq.rst | 295 +++ > >

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

2021-04-02 Thread Gedare Bloom
On Fri, Apr 2, 2021 at 12:19 PM Ayushman Mishra wrote: > > --- > user/bld/index.rst | 2 + > user/overview/index.rst | 2 + > user/start/faq.rst | 295 +++ > user/start/index.rst | 1 + > user/support/contrib.rst