Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs #51

Open
Integral opened this issue Aug 2, 2013 · 9 comments
Open

Docs #51

Integral opened this issue Aug 2, 2013 · 9 comments
Assignees

Comments

@Integral
Copy link
Member

Integral commented Aug 2, 2013

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
Copy link
Member

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
Copy link
Member Author

Integral commented Aug 2, 2013

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
Copy link
Member

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

@michael
Copy link
Member

michael commented Aug 2, 2013

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
Copy link
Member

michael commented Aug 2, 2013

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

@ghost ghost assigned Integral Aug 2, 2013
@Integral
Copy link
Member Author

Integral commented Aug 2, 2013

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

@michael
Copy link
Member

michael commented Aug 2, 2013

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
Copy link
Member

michael commented Aug 2, 2013

*posh time ;)

@Integral
Copy link
Member Author

Integral commented Aug 2, 2013

Okay!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants