Code: Select all
* API * Constants * Environment (as in JS API environment) * Events * Functions * Globals * Objects
The wiki has a very good search engine built-in, so if you know the name of a function/global/event/whatever you can just type it in to the search box and it will show suggested page links. With that in mind...
I'm trying an experiment, currently limited to functions (and I'm still in the process of moving stuff around as I type this), whereby I'm grouping them by what they relate to.
For example: Droids, Structures, Features, etc...
This will help group related functions together, and each 'topic' will have a summary page that also contains references to other things (eg. the Map topic will have links to FlaME, etc).
To do this, I'm moving the various "Quick Reference" pages I had in to the Functions section, then making related functions children of those pages as applicable.
This should make it easier to find stuff when you don't know what you're looking for. For example, if you want to do something with droids, but can't remember the function name, just look in the Droids topic.
I'm also thinking of doing the same with constants and objects, and then making the various topics top-level pages that appear in the sidebar. So you could click "Droids" and see all functions, constants and objects relating to droids.
Obviously, some things won't fit neatly in to this scheme. For example, eventDestroyed relates to features, droids and structures. I'm not quite sure how to deal with that yet, I might have to make stub pages or something. In fact, I might put events in their own section, and then have redirect pages within Droids, Structures, etc., topics?
Just wanted to know if anyone has feedback before I get too far in to making these changes.... In particular, when you go looking for a constant, for example, will it seem more natural to look under Droids for that constant, or would you expect to go look in a constants section instead?