sealcode / sealious

An extensible, declarative node framework
25 stars 2 forks source link

Technical documentation #188

Closed Wewe12 closed 8 years ago

Wewe12 commented 9 years ago

Making technical documentation with every function with return type and all possible argument.

arkadiusz-wieczorek commented 9 years ago

Do you think about technical documentation as description of API or as description all codes in framework, which there aren't interesting for many developers?

kuba-orlik commented 9 years ago

These two things should be separate in my opinion

Wewe12 commented 9 years ago

I thought about something like toutorial with description for beginner developer and separatly documentation with existing methods. It might be useful when someone want to find some method, argument or parametr.

arkadiusz-wieczorek commented 9 years ago

Yes it's good direction.

kuba-orlik commented 8 years ago

Tracked here now