Enhance ArkScript standard library documentation about ark HOT 10 CLOSED

Hey, I can help you with this!

from ark.

(Emailed, but i'm posting it here too for visibility).

Sorry you have not heard anything from me, I had family visiting the last few days. So far for the Ark wiki I have tried to revise the front page to be less messy-looking and cleaner, here is my current attempt at it: https://github.com/OfficePop/Ark/wiki

Take a look and let me know if you think this is the right direction (I also fixed some links that were broken for embedding and plugins). I was correcting uses of Nota bene to Note as the former term is not standard in documentation I am familiar with, but if it is considered typical and recognizable for your audience we can keep as-is.

from ark.

Hi, that would be awesome!

Currently the documentation (which is on the wiki) is pretty messy, everything is mixed up. I was thinking of something more organized, something like Python documentation, a page per module / data type.

I'll very soon reogarnize the standard library files and rename a few functions here and there for consistency and you'll be able to start without having to redo everything :)

Sounds good to you?

EDIT: please see #23 (comment)

from ark.

Sounds good, i'll be on notice!

from ark.

Just pushed the new standard library organization and updated the modules' functions naming convention!

from ark.

That looks better indeed!

Just a side note, in the virtual machine part on home.md, the last two links are on the same bullet point on your version, instead of being spread on two bullet points.

Sounds good to me for the nota bene/note part :)

from ark.

I corrected what you mentioned on home.md and added a new version of the introduction here, let me know your thoughts!

Since AFAIK Github doesn't support PR requests for wikis, how would you like to handle modifying the wiki in your repo? Also could help me to get some more understanding of what you want the wiki to look like in terms of "one module, one page" as I am not too familiar with Python documentation. If there any examples you can provide i'll take a look at them!

from ark.

I just remembered that collaborators could edit wikis, I added you so that you can modify it directly. I'm sorry, I should have thought about this long ago :/

In term of one module/page, I was thinking about something like:

• a page for the lists and the functions playing with them (functions can be in lib/List and in the FFI)
• a page for the strings and the functions playing with them (functions can be in lib/String and in the FFI)
• etc

from ark.

Hi @OfficePop, do you have any update on this?

from ark.

Closing due to inactivity

from ark.