This site works best with JavaScript enabled. Please enable JavaScript to get the best experience from this site.
Hello Ace!This isn't really an issue, but I couldn't find anywhere else to post this, so here goes.I use some of the Ace3 libraries in my own addon, but I found the documentation for Ace quite... lacking, for a lack of a better word (or maybe inaccessible is a better word, because I'm sure the wiki on here does technically contain almost everything; it's more about references and readability, I think). I am pretty passionate about documentation in general, so I decided to write up something.You can find the docs I created here: https://wowace-docs.nickdnk.workers.dev/It has everything in Ace3 documented, with up-to-date method signatures, links internally to relevant sections, (almost) no needless duplication and includes examples and tutorials inspired by some of the examples found on the wowace.com forum and/or here in the wiki on curse.
Why spend time on this? Documentation is essential for adoption of a tool among new developers, and the current documentation simply is not easy to follow. I'm sorry. And I know, I know, there's "documentation in the code", but it can still be quite daunting for a new WoW addon-developer to get into and understand the scope of Ace3. I know I didn't really get it at first, and if I'd had the above docs, I'd made a lot fewer beginner mistakes.The docs are currently in a separate git repo (my own) as I'm obviously not involved with Ace as a dev. I added the Ace3 Github repo as a submodule, which should make it trivial to adjust docs for changes as you'll have all the changes via commits within the same project.For adoptability, hosting it like this is not optimal, however, so I'd suggest we cooperate about integrating the documentation into official Ace3 resources by linking to it on both Curse and from the existing documentation (https://www.wowace.com/projects/ace3/pages/getting-started), perhaps moving it to a better location first, such as a subdomain or path on wowace.com.Let me know what you think.
To post a comment, please login or register a new account.