Jibble
 

AGS Wiki Updates/Discussion

Started by Hobbes, 01 Jun 2021, 12:32

« previous - next »

eri0o

#20
Hobbes, one thing would be cool to add is a meta page on the wiki about contributing to the wiki - like mentioning interesting things to add to the wiki and maybe a bit on how to do upkeep.

Oh, I found it, you already added, it's here: https://www.adventuregamestudio.co.uk/wiki/AGS:About:-D

I noticed the pages you edited the wiki looks better too, but I don't know why.

tampie85


Snarky

If I could comment...

All the tutorial stuff is from the manual. Maybe link there instead of duplicating it on the Wiki?
The poll stuff has no current relevance. I suggest it should simply be deleted. (Though it would be nice if it was archived for historical interest.)
As for the plugin instructions, I'm a bit leery of putting it in the Wiki. I think it belongs in the manual (preferably), or alternatively as documentation on Github. (I think I mentioned this before.)

tampie85

Oops... sorry, small misunderstanding with AGA. With 'Wiki' he meant it should live somewhere where it can be maintained by the community.

By all means, don't duplicate data. Do you have a link to the manual? Happy to add it somewhere in the redesign.

Who should I ask to add stuff to the manual, to make sure it doesn't get lost?

As for the stuff with no current relevance, AGA says he doesn't want to delete anything and that it should be kept somewhere for historical interest.
I don't think it should live somewhere on the site? Or do you disagree?

Crimson Wizard

#24
Quote from: tampie85 on 24 Jun 2021, 14:28
Who should I ask to add stuff to the manual, to make sure it doesn't get lost?

Manual source is here: https://github.com/adventuregamestudio/ags-manual
You may open a TODO issue, with links to original material, for example.
The manual is edited like wiki, using markdown: https://github.com/adventuregamestudio/ags-manual/wiki

Quote from: Snarky on 24 Jun 2021, 13:11
As for the plugin instructions, I'm a bit leery of putting it in the Wiki. I think it belongs in the manual (preferably), or alternatively as documentation on Github. (I think I mentioned this before.)

Here's the related issue: https://github.com/adventuregamestudio/ags-manual/issues/134
There's a Editor plugin page almost ready, except for the images, because i did not know how to insert them into markdown there (need to ask morganw or eri0o):
For the engine plugin API someone has to do a good effort and transfer an article into markdown format.

eri0o

CW, I will add but I will try to make new ones with VS2019 or VS2022. The current images use some incarnation of VS that is my age or something...

There's an open PR that documents along other things how to add images, still need to streamline it with Morgan before adding it.

Hobbes

Quote from: tampie85 on 24 Jun 2021, 12:50
Hobbes,

Would you mind adding a few items that currently live on the website to an appropriate location on the Wiki and make sure the content is up to date?

EDIT: never mind


I discussed this list with AGA, so it should make sense. Please let me know if you disagree or rather not add it to the wiki.

Hi Tampie, of course! It's been a bit crazy at work this week but I'll have a go at it this weekend. I'll look at Snarky's comment too and see if there's a lot of overlap between these website pages & the manual on GitHub and post back here in more detail.

tampie85

Quote from: Hobbes on 25 Jun 2021, 00:17
Hi Tampie, of course! It's been a bit crazy at work this week but I'll have a go at it this weekend. I'll look at Snarky's comment too and see if there's a lot of overlap between these website pages & the manual on GitHub and post back here in more detail.

Awesome! Would you mind creating the tickets for the manual too, as CW suggests? You probably know exactly what to request, while I'm not so much into the details of the documentation.

Hobbes

Hi all,

I've done the following:

- Opened a GitHub Issue concerning the Tutorial pages for the AGS Manual Wiki.
- Transferred the Polls to the AGS History part of the AGS Wiki.
- Transferred the Resources part to the "Getting Started Resources" page on the AGS Wiki. Can do with some cleaning up but functional for now.

I'm just now fully understanding the AGS Manual Wiki on GitHub. I think this is a Site Design suggestion, but I'll post it here anyway. Tampie85/AGA, would it be possible to have a more prominent link to the GitHub AGS Manual link on the main website? But rather than just cold-linking to GitHub, would it be possible for you to set up an account on https://readthedocs.org and link to GitHub from there?

I could set up the account on readthedocs as well, but since you'll be doing site-hosting/maintenance, I think it makes more sense you control this link. ReadTheDocs will pull live from GitHub anyway. But it'll help increase readability for outside / new users. I know I keep pointing out Godot as an example, but I do think they've done this quite well:

https://docs.godotengine.org/en/stable/?

Eager to hear what everyone thinks.

Moving forward, the AGS Wiki can then really become a repository for historical / wimsical things on one end and non-technical articles on the other (focused on game design, etc). My summer holiday is due to begin (the joys of being in education) so I'm looking forward to writing a larger tutorial for that place. :)

eri0o

#29
Hobbes, we purposedly don't use read the docs, the wiki is auto updated here:

https://adventuregamestudio.github.io/ags-manual/

The wiki on GitHub also is used for the generation of the version that is with the software.

Here's the continuous integration system we use for automation: https://github.com/adventuregamestudio/ags-manual/actions

We usually simply create a release after a few updates.

If you want, simply ask what you don't understand in the help system. The system is written using Pandoc and Lua, the reason being some things have special meaning on the AGS IDE, like people want to be able to select a code and hit F1 to get that piece of AGS standard API doc from the manual. It also needs to figure out additional info...

The reason it's not fully instantaneous per wiki update is that the manual wiki is completely open (everyone on the internet can write in it), we NEVER had irregular edits on the wiki, but I thought it was better to err in the side of caution, since the resulting text gets shipped with AGS.

Here's a bit of history:
https://www.adventuregamestudio.co.uk/forums/index.php?topic=56432.0

Also when making the theme there I think in the less fully featured browsers, since I imagine eventually we will modify AGS to have a web view and the manual pages will be in HTML form there - haven't needed yet to transition since support for the CHM in the .NET haven't been removed.

We also tried a ton of already existing tools for parsing the manual into it's html/chm forms, but they all had SOME problem that was unfixable, so after a while we settled on writing our tooling. Morgan did the work for the current Pandoc+Lua generator.

Hobbes

Aaaah, yes, I should've probably noticed that. I had already updated the Wiki link to that Manual page but didn't realise it was a fully rendered front end. Forget what I said about readthedocs. :-)

Hobbes

The Resources area from the AGS download page is now fully transferred to the Wiki:

https://www.adventuregamestudio.co.uk/wiki/Getting_Started_Resources

The SCI Fonts took a bit of manual copying-and-uploading-and-pasting to get all the GIF files to pop over.

The Font Pack (.zip file) is still linking to the AGS website version. This is because MediaWiki does not allow you to upload ZIP files.