search

HubPress / doc.hubpress.io

0 stars 0 forks source link

Is this going to be the docs hub for HubPress User docs? Or are we going to Wiki? #1

Open jaredmorgs opened 9 years ago

jaredmorgs commented 9 years ago

Hi @anthonny

Is this domain going to be where you have the full user guide?

If you want, we can start discussing the docs you need for the project. If you have any early dev docs you want grammar checked, please share them with me and I can help you out.

Your docs guy

J

anthonny commented 9 years ago

I had build a doc (a kind of javadoc) from the sources files with groc and i want to expose this doc, that's why i made this repo.

I just published statics files, could you have a look please ? :smile:

jaredmorgs commented 9 years ago

I've had a look at the first few classes. Things are coming along nicely. I really like how the grocdocs display the docs in-line with the code.

If I wanted to help you out with polishing these, what would I need to do. One thing I'd like to learn how to do is maintain API docs: its an emerging need for Tech Writers that will become a key employment factor in future years.

anthonny commented 9 years ago

I've had a look at the first few classes. Things are coming along nicely. I really like how the grocdocs display the docs in-line with the code.

I like grocdocs too :smile:

I generated this doc manually from the sources of the branch development. If you want, you can try to make the doc for the functions that you understand, then we can speak about it.

wdyt ?

jaredmorgs commented 9 years ago

I'd love to help out with making the grocdocs consistent for you. I'm not sure how much help I'd be writing them from scratch however.

Please let me know when you have a few more done and I'll do an editing pass over them.

Would that be OK with you?

On Sat, Feb 21, 2015, 02:09 Anthonny Quérouil notifications@github.com wrote:

I've had a look at the first few classes. Things are coming along nicely. I really like how the grocdocs display the docs in-line with the code.

I like grocdocs too [image: :smile:]

I generated this doc manually from the sources of the branch development. If you want, you can try to make the doc for the functions that you understand, then we can speak about it.

wdyt ?

— Reply to this email directly or view it on GitHub https://github.com/HubPress/doc.hubpress.io/issues/1#issuecomment-75263514 .