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

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

Open
jaredmorgs opened this issue Feb 19, 2015 · 4 comments

Comments

@jaredmorgs
Copy link

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

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 ? 😄

@jaredmorgs
Copy link
Author

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

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 😄

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

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 [email protected]
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: 😄]

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
#1 (comment)
.

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

2 participants