Ovale Spell Priority

75 - Documentation

What is the enhancement in mind? How should it look and feel?

To update the documentation.

Please provide any additional information below.

I feel that the documentation is lagging behind whats been implented in Ovale.
Many new functions isnt described or if they are it would be nice to have an example
Atm im forced to look in ovale default script or search the forums how people are using ovale.
This would make Ovale from being a A+ addon to be a A++ addon!
Maybe somehow turn this into a wikki where people can edit and help out with scripts and how functions can be implented in scripts

User When Change
jlam Oct 04, 2012 at 01:51 UTC
jlam Oct 04, 2012 at 01:51 UTC Changed assigned to from Sidoine to jlam
Gabrielz Apr 08, 2011 at 11:38 UTC Create

You must login to post a comment. Don't have an account? Register to get one!

  • 5 comments
  • Avatar of jlam jlam Jul 28, 2014 at 22:08 UTC - 0 likes

    In my mind, there are two parts to Ovale: the engine and the class scripts. Improving the engine is great, but the userbase is really hoping to just use the addon to help them play their class, so for them, the scripts are more important. I consider all of the requests to be important and valid and I try to fix both parts.

    There is documentation in the source for all of the conditions, but the autodoc generator seems to be broken at the moment, and I haven't made it a priority to write my own program to generate the documentation.

    I'm glad you enjoy using Ovale and I hope all of the changes and sometimes brokeness doesn't turn you off too much. It's all in the name of improving the overall quality and accuracy of Ovale, and with this project being so small, it's hard to get up the enthusiasm to do a real release engineering cycle with commit-test-feedback-release. I just play changes on a few key toons and if it works, I release and try to fix bugs quickly :-)

  • Avatar of Ophidon Ophidon Jul 27, 2014 at 12:13 UTC - 0 likes

    A lot of work has been done to the back-end lately which is great. So personally, I think this is the current largest open issue still.

    An overwhelming number of the requests/complaints seem to be about can you fix/add X or Y script? I don't think you really want to try to keep every single spec's script up-to-date for every single patch do you? Better scripting documentation, as understandable as possible by non-programmers, and preferably viewable inside the add-on inside the game itself shifts that responsibility back onto the rest of the playerbase instead of you. :) Might liven up the forums more with people sharing more scripts too (especially if you add a link from the add-on to the forums.

    Just my thoughts. I love Ovale. :)

  • Avatar of jlam jlam Mar 14, 2013 at 14:39 UTC - 0 likes

    Other information on documentation issues is in ticket 185, which has been closed but the issue reported there should be addressed in this open documentation ticket.

  • Avatar of jlam jlam Oct 10, 2012 at 16:05 UTC - 0 likes

    I have started by formalizing the documentation system for the script conditions, and almost all of those are documented in the current Ovale.

  • Avatar of SntAsher SntAsher Apr 12, 2011 at 18:16 UTC - 0 likes

    I agree the documentation defiantly needs an update i spend a lot of my time reading Forum post trying to figure out how to use a function that's not in the documentation.

  • 5 comments

Facts

Last updated
Jul 27, 2014
Reported
Apr 08, 2011
Status
Started - Work on this issue has begun.
Type
Enhancement - A change which is intended to better the project in some way
Priority
Medium - Normal priority.
Votes
4

Reported by

Possible assignees