I'm currently doing nothing for a week after surgery on my foot, so I can try to work on the manual for a few days if I know what and where the final result should be.
So, I can create a new "ags-manual" repository in the community group. But I got distracted and haven't quite realized what was the outcome of eri0os's experiments. I recall he tried several things, including storing pages in a github Wiki. I am unaware how you access that through git means, and whether its possible to work with on your local disk if you prefer to edit files directly.
His findings are listed here, it seems:
http://www.adventuregamestudio.co.uk/forums/index.php?topic=51340.msg636589833#msg636589833Anyhow my proposal stands this:
1) we seem to have decided on having source in Markdown, so be it.
2) the new repository may be thought as an experiment where nothing is set in stone, but the general idea is to have current manual converted into Markdown and brought to a better chapter/page structure.
3) Big LaTeX file may be found here, as usual:
https://github.com/adventuregamestudio/ags/tree/master/ManualIf you cannot convert this to HTML yourself (still not certain if conversion works fully on Linux):
https://www.dropbox.com/s/snrrhug5ugrc52l/ags-manual-htmlpages.zip?dl=04) Suggestions on chapter structure:
http://www.adventuregamestudio.co.uk/forums/index.php?topic=51340.msg636589906#msg636589906That, and my own post after that suggests larger division on root level.
Probably, manual source (in markdown) should be placed in its directory (e.g. "src" or "docs"), because we may also have some conversion scripts in the repository?
I think that, in terms of script reference, it would be possible to generate this on demand, because the information is already entered so that the compiler/autocomplete can use it:
builtin managed struct Character {
/// Adds the specified item to the character's inventory.
import function AddInventory(InventoryItem *item, int addAtIndex=SCR_NO_VALUE);
/// Manually adds a waypoint to the character's movement path.
import function AddWaypoint(int x, int y);
...
So what is entered as / converted to Markdown doesn't necessarily need to cover the script functions.
Do you mean generating articles this way, or actual help content? Currently in the script reference articles are larger than that, having elaborations, warnings, examples etc.