substance / data

A uniform interface for domain data (deprecated)
http://code.substance.io/docs/substance-manual/
MIT License
655 stars 44 forks source link

Docs #51

Open Integral opened 11 years ago

Integral commented 11 years ago

Hey-hey! Sorry, I see some improvements on data.js. Last time there was only one file and now... :) What should I do with docs? Can I continue? Maybe I should do it in master branch, so it'll be save after next spreading? And let's decide something about docs style, ok?

obuchtala commented 11 years ago

Hey Daniel!

U r right... I spreaded them as it became to large. I will take care of merging your changes into the new structure.

About doc style: we have in mind to be somewhat markdown compatible in the docs. Though, we did not come to a final decision there.

Cheers, Oliver

Integral commented 11 years ago

Hi, Oliver! Don't worry, I can add it by myself because as I understand it's the same file but broken into pieces :) So we are just using ======= and ------------ for different level of headers, yeah?

obuchtala commented 11 years ago

Yeah... use the headers as in a markdown only file... For extra levels you can use ##(#)+, too.

michael commented 11 years ago

Yeah mardown it is.. with careful usage of backticks for variable names etc. Let's try that data.js docs look nice when run through docco. I'll start next week documenting the Article module in the same way.

michael commented 11 years ago

Will now continue working on the converter sandbox integration... see you a bit later on IRC maybe.

Integral commented 11 years ago

Good. Thanks! I'm not closing this issue so you can keep track of documentation progress. Will commit to master.

michael commented 11 years ago

Awesome. Also.. please bring it up if you see anything that doesn't make sense API wise or if it could have a more userfriendly interface. Just saying since writing docs usually reveals all the API inconsistencies. It's polish time! :)

michael commented 11 years ago

*posh time ;)

Integral commented 11 years ago

Okay!