search

kentcdodds / nps-utils

Utilities for http://npm.im/nps (npm-package-scripts)
https://doclets.io/kentcdodds/nps-utils/master
MIT License
101 stars 23 forks source link

Feature: better documentation #31

Closed morgs32 closed 4 years ago

morgs32 commented 5 years ago

Accidentally created the issue before writing the description. So:

  1. This doesn't work for me. https://doclets.io/kentcdodds/nps-utils/master
    • Once it loads (which takes a few) I can't navigate around it without getting a 502.
  2. This generated documentation is sub par: https://doc.esdoc.org/github.com/kentcdodds/nps-utils/function/index.html#static-function-crossEnv
    • It's probably convenient to run (in CI/CD process). It's maybe convenient for you to maintain? But more important than all that is it's just not as intelligible as we (the greater community) has come to expect from senior engineers such as yourself. I mean that with respect of course.

If you would like me to volunteer, I would help you redo it. Gitbooks, a nextjs app, whatever you want.

kentcdodds commented 5 years ago

Hi @morgs32 👋

I'm looking forward to your PRs 😄

Update:

Yeah, I agree the esdoc thing doesn't work well at all. I'd rather just move everything to the README. Would you like to do that?

morgs32 commented 5 years ago

~Yes I'll give that a shot!~ I didn't have as much need for this as I thought. I presume I'm not the only one?