OK, so should I give the help another sort order (according to the new folders) when they are fixed in the next time?
The main problem are only the hyperlinks within the single files, but this is doable.
Willi
Sent: Monday, October 28, 2024 at 1:55 AM
From: "Jerome Shidel via Freedos-devel" <freedos-devel@lists.sourceforge.net>
To: freedos-devel@lists.sourceforge.net
Cc: "Jerome Shidel" <jer...@shidel.net>
Subject: Re: [Freedos-devel] FreeDOS documentation
From: "Jerome Shidel via Freedos-devel" <freedos-devel@lists.sourceforge.net>
To: freedos-devel@lists.sourceforge.net
Cc: "Jerome Shidel" <jer...@shidel.net>
Subject: Re: [Freedos-devel] FreeDOS documentation
Hi Willi,
On Oct 27, 2024, at 6:36 PM, Wilhelm Spiegl via Freedos-devel <freedos-devel@lists.sourceforge.net> wrote:
Does this mean that htmlhelp and the freedos help is no longer needed?
Willi
Based on the discussion we had during the get-together, the exact opposite.
Of course, this all needs discussed here on the list. However, we floated several ideas during that meeting.
One possibility is to use a few utilities to convert the documents being developed in the GitLab project from markdown to html.
Doing that would make them easy to view using HTMLHELP.
It may even be desirable to fully integrate those converted documents into the help system.
:-)
Jerome
_______________________________________________ Freedos-devel mailing list Freedos-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/freedos-devel--
Gesendet mit der mail.com Mail App_______________________________________________
Am 27.10.24, 23:21 schrieb Jim Hall via Freedos-devel <freedos-devel@lists.sourceforge.net>:It's finally moving forward. :-)
I showed this on the virtual get-together this morning (and did some
live-edits during the meeting) but I wanted to bring it back to the
email list.
I've started work on the new Documentation. As discussed on the list
before, this will live in our GitLab so that others can contribute to
it:
https://gitlab.com/FreeDOS/docs
I've added some notes in the Contributing file (link below). To start,
we'll have three categories of documentation:
1. The "howto" category will have "how-to" articles and tutorials. I
think this is what most new users will want to use. For example, folks
discover FreeDOS who have never used DOS before, and want to know "how
do I use it" or "how do I use the command line." These "how-tos"
should be focused tutorials to show how to do something.
2. The "about" category will contain copies of the FreeDOS Manifesto,
the original June 29 1994 announcement, and other copies of
announcements and similar documentation.
3. The "info" category will document special files or conventions,
such as "About the package file format." Think of these as "technical
definitions" of specific topics .. we might add a "VM" entry to
explain "what is a virtual machine" and list several virtual machines
you can use.
https://gitlab.com/FreeDOS/docs/-/blob/master/CONTRIBUTING.md
I've moved over some articles that I've written about FreeDOS into the
"howto" directory, just to get started.
The GitLab "docs" directory also contains a sample "index" page and
CSS file for a new Documentation website. I plan to rename
wiki.freedos.org to docs.freedos.org, with the new website. [This
"index" page is a 'placeholder' page right now. It has basic
functionality and will get updated. Also, I won't update this file
automatically from GitLab .. I'll maintain that on the web server, and
push any updates to GitLab.]
There's also a script to turn the Markdown files from GitLab into
pages on the new Documentation website. With a script like this, I can
automate the process, maybe a weekly process to update the
docs.freedos.org site with new changes. [This is another 'placeholder'
that will get updated. I won't update the script automatically from
GitLab .. same as the "index" page. I'll maintain this on the web
server, and push any updates to GitLab.]
Over time, I want to move the FreeDOS books to the FreeDOS "docs"
directory, under a new "docs/books" directory. But the organization
for the "books" directory (and how to display those on
docs.freedos.org) needs some planning first. That's not an urgent
issue, the books can wait.
Jim
_______________________________________________
Freedos-devel mailing list
Freedos-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/freedos-devel
Freedos-devel mailing list
Freedos-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/freedos-devel
_______________________________________________ Freedos-devel mailing list Freedos-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/freedos-devel
