hkzorman / advanced_npc

Advanced NPC for Minetest, using mobs_redo API
Other
18 stars 5 forks source link

Initiating documentation #25

Closed BrunoMine closed 6 years ago

BrunoMine commented 6 years ago

This is an initial basic structuring of the documentation (based on the minetest documentation)

BrunoMine commented 6 years ago

I'm thinking of a more enjoyable way to view the API documentation, without having to keep two documentation (eg wiki) Maybe a html page generator or maybe change the text documentation to md. I'm thinking about this in advance to avoid rework in the future.

hkzorman commented 6 years ago

This is a really fantastic job! These docs are great! .md format is good enough for me. I feel like the wiki might be unnecessary in the future, given these API docs you are working on...

hkzorman commented 6 years ago

@BrunoMine Do you want me to merge this as is and any other documentation changes to be added in the future, or would you to keep this open and add more docs here?

BrunoMine commented 6 years ago

I'm going to work on converting the .txt documentation to a .md. So this PR is not yet ready to be merged.

BrunoMine commented 6 years ago

Ok. It is ready.

hkzorman commented 6 years ago

Fantastic work. Thank you very much!