Hi everyone If you recall, we migrated our documentation to a directory on GitLab, so that more folks can contribute to the documentation. But I never took the extra step to automate the processing of the documentation into a website so the documentation can be viewed as HTML.
I've (finally) set up the new documentation website at: https://help.freedos.org/ This is very rough, and the website design is quite plain, but you can see where it's going. The goal is to have sections for tutorials & how-to guides, plus different kinds of information about FreeDOS ("about" pages and "info" pages). The Markdown is converted to HTML with the original Markdown.pl (from https://daringfireball.net/projects/markdown/) -- I'm using this version because the server doesn't have pandoc, so I can't use that. A few notes & known issues: 1. The script to convert the files was a quick fix, so it only converts Markdown files that are in each of 'howto', 'about' and 'info' (it does not process subdirectories). I'll update this later. 2. Links between pages are currently broken. This is because the links are in Markdown, and link to other Markdown files. The pages should either be updated so they don't need to link to other pages, or the script will need to automatically change the links, or both. But for right now, just know the links are broken. 3. The top of the page has "How to get started" which is meant to link to important "quickstart" documents from the other directories. This is (intentionally) a curated list and can change over time. 4. My intention is to run this script via cron (every week?) so that any updates and changes to the Markdown files on GitLab will get reflected on the website automatically. 5. You can also see that some pages need to be updated. Some of these are grammar/style issues, or incorrect Markdown (see the link in "howto/cddir.html") or something that Markdown.pl seems to have trouble with (see the tables in "info/package.html"). But at least now anyone can update the documentation on GitLab and it will get fixed more quickly. I'll update the www.freedos.org site with a link to the new "Help" site after some of the Markdown files have been updated/fixed. _______________________________________________ Freedos-devel mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/freedos-devel
