Author Topic: Documentation  (Read 662 times)

Omega

  • MegaGlest Team
  • Dragon
  • ********
  • Posts: 6,167
  • Professional bug writer
    • View Profile
    • Personal site
Documentation
« on: 18 November 2011, 18:12:48 »
This is the initial list, and may be prone to missing many features. Please feel free to mention them below.

Well, it looks like MegaGlest's documentation on the Glest Wiki is starting to fall behind, so I'll be trying to bring it back up to date, with many of the new features. MegaGlest does have a Features page like GAE, but only has one "in-depth" feature page, whereas GAE has 24. MegaGlest has more than one feature that can be described in depth (eg, cliffs), and if we fail to document the syntax and usage of new features, they may end up lost, and future MegaGlest mods may not be able to utilize features simply because they don't know about them, or may have to waste time trying to get help in their usage simply because there's no "instruction manual".

As well, it's especially helpful for existing modders to have a reference, as our new features are scattered across the feature request and megaglest board, with some even hidden away in side mentions on unrelated threads. Thus, this topic will be a list so we can keep track of the pages that still need to be created, the pages that have already been created (for reference), and related to-do for MegaGlest on the wiki.

[big][big]Pages to be created[/big][/big]
[small]Features here link to the forum post detailing their installation, if it exists. Note that not all features listed here will get a "dedicated page", generally just those that would benefit from examples and an in depth explanation. For example, Lua features go on MG/Scripted Scenarios.[/small]
[big][big]Pages already created[/big][/big]
[small]Features here link to the wiki page the feature is described on (the detailed page if it has one, the XML documentation if it does not)[/small]
[big][big]To do list[/big][/big]
[small]Other stuff that should be done[/small]
  • Make redirects for pages. A detailed features page should always be named "MG/Features/Feature_name", so to ensure searchers can easily find pages, the page named "feature_name" and similar names should be redirects. Note that a redirect that could apply to either an MG or a GAE feature should be a disambiguation page.
  • Verify the integrity of MG/INI.
  • Ensure that features that only work in an unreleased version of MG (ie, from the SVN) detail the revision the feature was added.
  • Ensure that pages are in the category Detailed feature pages and MG.
  • A page should be created for the MG tray application



As with all lists, this will grow outdated as individuals create pages, new features are added, etc, so feel free to post on missing features or errors.
« Last Edit: 18 June 2016, 16:24:09 by filux »
Edit the MegaGlest wiki: http://docs.megaglest.org/

My personal projects: http://github.com/KatrinaHoffert

softcoder

  • MegaGlest Team
  • Battle Machine
  • ********
  • Posts: 2,239
    • View Profile
Re: Documentation
« Reply #1 on: 19 November 2011, 04:55:05 »
Yes there is much to document, and this will come shortly.

 

anything