Hi, As you probably know, currently the only ASDoc (our API Reference) is itself a Royale app running on the CI server. It is sort of ugly, so I plan to spend a little bit of time making it look better. Volunteers to help or provide feedback are welcome.
Because it is an app, I think it will be easier to add fancy filtering to help users find things, so I think it is the right long-term strategy. However, one major drawback is the app is not search-engine friendly. This is also a problem I think we can solve, but that may take a bit of work. Meanwhile, I've learned a bit about Jekyll and realized we could generate a static ASDoc site with a bit of work as well. The current ASDoc app uses a pile of JSON files that the compiler knows to spit out. We could teach the compiler to spit out MarkDown instead of JSON, or run a script that generates a MarkDown stub for each JSON file and create a template that reads in the JSON file to be used to generate the .html file. The question is: how important is static ASDoc that can be indexed by the search engines? Especially relative to other things like writing more doc and improving the examples. Or maybe we should focus on making Royale apps work well with search engines. Thoughts? -Alex
