Ok... I know that typing ashref in the gCLI will list some ash commands, and I know that there is a "manual" AND a wiki "Documentation" site... however even with all these resources it seems that there is quite a bit of "hidden" features in ash.
I would not mind helping to document the ash commands, but not all of them are shown when you type ashref. For instance, i know that notify is not listed and attack and a few of the consult script specific functions... Also it seems (I don't know for sure because i don't use the CLI too much) that a few of the CLI commands are not documented. Many of the functions documented are outdated, the names changed, the return values changed etc.
I think that the documentation wiki has a slightly clunky design. Would it be ok for me to try and do some updating? Where can I find a full list of ash functions (Is there somewhere in the source where it is all handled)? Where can I find a full list of CLI commands (again is there somewhere in the source where this is all listed)? Where can I find a full list of Consult script commands(somewhere in the source)?
My proposed plan of action:
Create a new wiki documentation from scratch on the current wiki documentation site.
Phase one: Create main_page_alpha
Phase two: Create wiki stubs for the complete design each stub ending with the _alpha postfix.
Phase three: Populate the stubs.
I think there should be a predefined template. Something along the lines of:
[feature name]
[cli name] [arg1][arg2]...[argN]
[argument1 meaning and valid values]
[argumentN meaning and valid values]
[A non technical overview of what this command does]
[return type] = [ash name] [argument1] [arg2]...[argN]
[ash name and arguments for overloaded]
[argument1 meaning and valid values]
[argN meaning and values]
[Non techincal overview of what this function returns]
Phase four: remove the _alpha postfix.
Phase five: Prepare for the future of kolmafia by keeping accurate documentation on the accuracy of each wiki page. To do this I propose there be some kind of accuracy ensured image label acc_[latest major kolMafia ver number.] Each wiki page would have a link to an image named acc_[major version kolMafia page is accurate for]. Whenever a major version is changed the image of acc_[major kolMafia ver number being replaced] is changed from whatever symbol means accurate to whatever symbol means outdated.
The main page would not contain this symbol, although next to each link to a functions information this symbol (or a smaller one) would indicate if the link had been updated for the newest ver.
Also I propose an Unupdated link which would contain a list of all the functions that have not yet been updated for the newest version to allow ease of updating. If a feature is completly removed or replaced the page for that feature would be considered updated when it is changed to reflect this removal or replacement.
I realize that this is quite a large task, I think I could get it going... However I don't have full knowledge on what each function actually does and what each arg is actually supposed to represent. Nor do I have full knowledge of what all the commands and functions actually are.
I think I may start this now... if anyone is opposed to this idea I would delete anything I had done before the idea was vetoed. This is simply a post to a) Request permission, b) Request support, and c) Create awarness of the propossed idea.
I would not mind helping to document the ash commands, but not all of them are shown when you type ashref. For instance, i know that notify is not listed and attack and a few of the consult script specific functions... Also it seems (I don't know for sure because i don't use the CLI too much) that a few of the CLI commands are not documented. Many of the functions documented are outdated, the names changed, the return values changed etc.
I think that the documentation wiki has a slightly clunky design. Would it be ok for me to try and do some updating? Where can I find a full list of ash functions (Is there somewhere in the source where it is all handled)? Where can I find a full list of CLI commands (again is there somewhere in the source where this is all listed)? Where can I find a full list of Consult script commands(somewhere in the source)?
My proposed plan of action:
Create a new wiki documentation from scratch on the current wiki documentation site.
Phase one: Create main_page_alpha
Phase two: Create wiki stubs for the complete design each stub ending with the _alpha postfix.
Phase three: Populate the stubs.
I think there should be a predefined template. Something along the lines of:
[feature name]
[cli name] [arg1][arg2]...[argN]
[argument1 meaning and valid values]
[argumentN meaning and valid values]
[A non technical overview of what this command does]
[return type] = [ash name] [argument1] [arg2]...[argN]
[ash name and arguments for overloaded]
[argument1 meaning and valid values]
[argN meaning and values]
[Non techincal overview of what this function returns]
Phase four: remove the _alpha postfix.
Phase five: Prepare for the future of kolmafia by keeping accurate documentation on the accuracy of each wiki page. To do this I propose there be some kind of accuracy ensured image label acc_[latest major kolMafia ver number.] Each wiki page would have a link to an image named acc_[major version kolMafia page is accurate for]. Whenever a major version is changed the image of acc_[major kolMafia ver number being replaced] is changed from whatever symbol means accurate to whatever symbol means outdated.
The main page would not contain this symbol, although next to each link to a functions information this symbol (or a smaller one) would indicate if the link had been updated for the newest ver.
Also I propose an Unupdated link which would contain a list of all the functions that have not yet been updated for the newest version to allow ease of updating. If a feature is completly removed or replaced the page for that feature would be considered updated when it is changed to reflect this removal or replacement.
I realize that this is quite a large task, I think I could get it going... However I don't have full knowledge on what each function actually does and what each arg is actually supposed to represent. Nor do I have full knowledge of what all the commands and functions actually are.
I think I may start this now... if anyone is opposed to this idea I would delete anything I had done before the idea was vetoed. This is simply a post to a) Request permission, b) Request support, and c) Create awarness of the propossed idea.