Re: [Emutos-devel] EmuTOS User Manual online!

[Eero T. <oa...@he...>]

Hi,

On 26.5.2021 21.07, Vincent Rivière wrote:
> The EmuTOS User Manual is now online!
> See our EmuTOS homepage. I have added a Manual menu item.
> https://emutos.sourceforge.io/
> 
> That Manual link opens the manual in a new tab. It is currently hosted at:
> https://emutos.github.io/manual/
> 
> And the manual source is hosted in this Git repository, in MkDocs 
> format. Any push will deploy the changes to the above location.
> https://github.com/emutos/manual
> 
> Many thanks to Charles Curley for his hard work on this manual, and to 
> Christian Zietz for the deployment machinery!
> 
> This manual will be another great feature for the upcoming EmuTOS release.

Looks good!


Few comments / questions:

* Why "The EmuTOS User Manual" is in table of
   contents?

   Heading for the whole manual is before TOC, and
   causes extra indent for all other TOC items, so
   it's a bit weird to include it there...


* In "Documentation in the Distribution" section,
   document names could be links to those
   documents,for example:
   https://raw.githubusercontent.com/emutos/emutos/master/doc/announce.txt


* "We highly recommend testing the zip file after
   you pull it in, especially if you aren't going
   to use it immediately." <- Latter part seems
   redundant


* List of EmuTOS archives is missing proper
   descriptions for some of the files:

   "EmuCON only as a .prg executable"
->"EmuCON shell program as separate executable"?
    (or add link to EmuCON section)

   "FireBee executable"
->"Firebee version of EmuTOS as program"???


* "Note that the old standby ^C (for copy) and
   ^P (for paste) don't work for copying files
   or directories."

   => What "the old standby" means here?


* "Select "Auto" to autoboot this application
   (see above)"

   => What "(see above)" refers to?
      (There's e.g. no section on boot order)


* "launch the program in character mode"

   => maybe "text mode"?


* Cache: Maybe similar to blitter, add "some
   programs do not work correctly with it, so
   you can disable it"?


* ACC: "To deactivate, rename the file or"

   => ", change the .ACC extension, or"?


* CPX: I thought the idea with these was that
   they can be loaded & unloaded at run-time
   (i.e. don't necessarily stay resident)?


* EmuCON:
   - tab -> TAB?
   - Commands in the table left column could also
     be shown with monospaced like in right column
   - "Like cat and TYPE."
     => "Like Unix cat and DOS TYPE commands."?


* "Native Features support. This is a number of
    features that some ST emulators provide, and
    which EmuTOS supports."

   => "... These are 'pass-through' features that
     some Atari emulators provide.  EmuTOS supports
     a subset of those features."

    (Aranym specifically is NOT an 68000 ST
     emulator, as it mostly emulates 040 Falcon.)


* In general screenshots of the discussed GUI
   elements would be great.


	- Eero