Frank Kuehndel commented: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/94#note_120511 @amar I have absolutely no time left for the next three maybe six months. I dislike to make suggestions when I cannot provide any help realizing them. Since you asked, a few points (which may not be in line with anybody else): * One could split the README: - The parts about "Documentation Standard", "Images" and Restructured Text (from "Introduction") could go into the RTEMS Engineering Manual (e.g. section "6.4 Documentation Guidelines") - The part on how to build the documentation (e.g. Dockerfile) and how to configure the build (current section "Building") could go into the RTEMS User Manual. - The rest (such as old information about building documentation on different OS) could stay in the README together with links to the above mentioned parts. * For the part on how to build the documentation (e.g. in the Users Manual), I would only provide a Dockerfile plus the info which is currently in section "Building". Most of the information about LaTeX, Sphinx, npm, etc. is mostly implicitly covered by a Dockerfile. - I think it would be better to use Ubuntu as OS for a Dockerfile. It is more common than OpenSUSE. Fedora may be an option if you think this makes a difference in documentation quality. I am happy to provide a Dockerfile for a different OS than OpenSUSE but it will take some time till I find a slot for it. - I would refrain from supporting more than a single OS. It is some effort to regularly check and update any Dockerfile. I think it is not worth it as few users will actually build the documentation on their local hosts. Users which want to build for another OS could be pointed to the possibly outdated "hints" in the README. * One could of course reorganize the README and shorten it without distributing parts into other RTEMS Manuals. -- View it on GitLab: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/issues/94#note_120511 You're receiving this email because of your account on gitlab.rtems.org.
_______________________________________________ bugs mailing list bugs@rtems.org http://lists.rtems.org/mailman/listinfo/bugs
