Documentation Revision
Entry posted by Josh ·
3,896 views
The new docs system is mostly working now:
https://www.leadwerks.com/learn?page=API-Reference_Object_Entity_SetPosition
Features:
- Treeview list of all tutorials and API classes and functions.
- Alphabetical index (generated automatically from the table of contents).
- Search (with autogenerated search index).
- Switch back and forth between languages, with cookies to remember your preference.
- Entire examples are automatically selected when you click on them.
Todo:
- Table of contents doesn't yet navigate.
- I would like to pretty-up the URLs using .htaccess rewrite rules.
Documentation is being loaded from XML files. I find this easier than a database, which is quite opaque to me. You can access some of the XML files being used here. MartyJ even made a cool template for the data on his site here.
At this point I think I can outsource the actual content creation to Upwork. This will involve copying and formatting our existing documentation into XML files, as well as updating all the examples to work by just using a main() function instead of the old App() class that we don't really need. I will be posting the job on that site soon.
-
2
16 Comments
Recommended Comments