Todd, you might want to remove the . from the end of that link!
But yes, that does sound like an excellent idea.
I'd like to make a couple of suggestions for the structure of this though.
Maybe it would be best to simply set up a structure that mirrors the module based command reference (your modules section) with all commands listed. We can then add comments / improvements to each command as we identify them. Not sure what extra the Functions bit is adding, is that just summarising the content of modules?
As for your other sections, I think they could be clarified / tidied up a little. I'd suggest:
Modules & Command Documentation
+ Module Name
-Command Name
...
Getting Started Articles
- Migrating from other versions of Blitz
- Double Buffering
- Intro to OOP
- Shoot 'em up (Non OOP)
- Shoot 'em up (OOP)
...
Advanced Articles
- Creating Modules
- Cross-Platform Gotchas
- Game Timing
- Clever OOP tricks
...
BMX Modules
+ BRL Modules
+ User modules / functions
Where articles can include step by step tutorials, descriptions of concepts, AND samples. (I include the latter because I strongly believe that samples on their own aren't much use. They should always have at least a cursory description of what they do, and more importantly HOW they do it.)
One question though, how do BRL feel about such documentation being free to all? We may need to be very careful on copyright of existing documentation...
But yes, that does sound like an excellent idea.
I'd like to make a couple of suggestions for the structure of this though.
Maybe it would be best to simply set up a structure that mirrors the module based command reference (your modules section) with all commands listed. We can then add comments / improvements to each command as we identify them. Not sure what extra the Functions bit is adding, is that just summarising the content of modules?
As for your other sections, I think they could be clarified / tidied up a little. I'd suggest:
Modules & Command Documentation
+ Module Name
-Command Name
...
Getting Started Articles
- Migrating from other versions of Blitz
- Double Buffering
- Intro to OOP
- Shoot 'em up (Non OOP)
- Shoot 'em up (OOP)
...
Advanced Articles
- Creating Modules
- Cross-Platform Gotchas
- Game Timing
- Clever OOP tricks
...
BMX Modules
+ BRL Modules
+ User modules / functions
Where articles can include step by step tutorials, descriptions of concepts, AND samples. (I include the latter because I strongly believe that samples on their own aren't much use. They should always have at least a cursory description of what they do, and more importantly HOW they do it.)
One question though, how do BRL feel about such documentation being free to all? We may need to be very careful on copyright of existing documentation...