Documentation | Convert files from reST to MarkDown (!155)

[Gedare Bloom (@gedare)]

Merge request https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/155 was reviewed by Gedare Bloom

--
  
Gedare Bloom started a new discussion on bsp-howto/index.md: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/155#note_120178

 > +```{topic} Copyrights and License
 > +(c) 2017 Christian Mauderer
 > +

These additional blank lines were not in the original rst, and they generate additional vertical whitespace in the generated docs.

--
  
Gedare Bloom started a new discussion on bsp-howto/index.md: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/155#note_120179

 > +
 > +```{topic} Copyrights and License
 > +(c) 2017 Christian Mauderer

Any reason some of the manuals use `{{ copy }}` but this one still has `(c)`?

--
  
Gedare Bloom started a new discussion on c-user/glossary.md: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/155#note_120180

 >  
 > -        It has two variants, :term:`Weak APA` and :term:`Strong APA`.
 > +: This term is an acronym for Application Binary Interface.

This is not desirable formatting.

--
  
Gedare Bloom commented: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/155#note_120181


The generated html https://ftp.rtems.org/pub/rtems/people/amar/docs1/user/ lacks section numbering.

--
  
Gedare Bloom commented: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/155#note_120182


The generated PDF files have missing key terms in the Index Chapter (that is created at the end of the PDF file). 

Note: This Index Chapter does not get created for HTML output, which is how it was with ReST too.

--
  
Gedare Bloom commented: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/155#note_120183


The generated PDF files add a "Bibliography" chapter with all the cited references after the (now empty) "References" chapter. The generated HTML just creates the "References" chapter, which is consistent with the previous HTML from ReST. 

Note: The older generated PDF docs just created the "Bibliography" chapter. https://docs.rtems.org/docs/main/c-user.pdf#chapter*.288

--
  
Gedare Bloom started a new discussion on c-user/rtems_data_types.md: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/155#note_120184

 > -============
 > +% or raise a bug report:
 > +

extra blank lines are not wanted.

--
  
Gedare Bloom started a new discussion on c-user/rtems_data_types.md: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/155#note_120185

 > +
 > +: This member contains the maximum number of Classic API Tasks configured for
 > +  this application. See {ref}`CONFIGURE_MAXIMUM_TASKS`.

These `{ref}` are not working, see https://ftp.rtems.org/pub/rtems/people/amar/docs1/c-user/rtems_data_types.html#rtems-api-configuration-table


-- 
View it on GitLab: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/155
You're receiving this email because of your account on gitlab.rtems.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/bugs/attachments/20250224/c926b02b/attachment-0001.htm>