search

hapijs / good

hapi process monitoring
Other
525 stars 161 forks source link

Added API documentation #378 #399

Closed danecando closed 9 years ago

danecando commented 9 years ago

Moved API docs from README.md to API.md following the new module documentation changes

arb commented 9 years ago

Wow, this looks great! Did you use a script to do it?

danecando commented 9 years ago

Thanks! I didn't use any scripts. Just tried to follow suit with some of the other repo's in the ecosystem.

arb commented 9 years ago

Ok, if you did it by hand, can you remove the comments in the markdown and also drop the version information? I don't really feel like maintaining that.

danecando commented 9 years ago

Sure, no problem. Which comments do you mean though? the <-- --> stuff that wraps the section links?

arb commented 9 years ago

Yep. I think you looked at Joi and that uses a script to keep that up to date so that's where those comments come from.

danecando commented 9 years ago

Yeah I was comparing a few of the different repo's to get a feel for how it was done. So just to confirm, leave the section links but remove the version and wrapping comments?

arb commented 9 years ago

Yeah just have it read "API Reference" and remove all the <-- --> stuff.

lock[bot] commented 4 years ago

This thread has been automatically locked due to inactivity. Please open a new issue for related bugs or questions following the new issue template instructions.