search

jshint / jshint.github.io

The homepage for JSHint
http://jshint.com
20 stars 19 forks source link

Improve docs #24

Closed jugglinmike closed 9 years ago

jugglinmike commented 9 years ago

@caitp @rwaldron Mind giving this a once-over for me?

Resolves

caitp commented 9 years ago

are the api docs automatically generated from the jshint repository? If not, we should really fix that, or they'll go out of sync very easily.

jugglinmike commented 9 years ago

They are not. I agree that generating them would be preferable, and that's what has kept me from writing this documentation for so long. I ultimately decided it was more important to publish something, even if it wasn't perfect. I haven't been able to find the time to set up documentation generation for the API, but in the mean time users are on their own when it comes to using it. There have been no changes to the API for as long as I've been on the project, so I think this is acceptable (for now at least).

caitp commented 9 years ago

I'm fine with landing this, but we should really use jsdoc or dgeni in core asap

jugglinmike commented 9 years ago

Thank you

macgyver commented 8 years ago

Just curious - where can I find this documentation? It doesn't seem to be on http://jshint.com/docs/options/

jugglinmike commented 8 years ago

That page's documentation is derived from the JSHint source code:

This page's content is sourced from the JSHint project repository. If you spot an error, please open an issue or (better yet) make a pull request!

The changes introduced by this pull request are dispersed across the other documentation pages. You can use the filename as a general guide, but the specific URLs are specified via JSON values declared at the beginning of each file.

macgyver commented 8 years ago

Got it, thanks!

On Thu, Dec 17, 2015 at 9:48 AM, jugglinmike notifications@github.com wrote:

That page's documentation is derived from the JSHint source code:

This page's content is sourced from the JSHint project repository. If you spot an error, please open an issue or (better yet) make a pull request!

The changes introduced by this pull request are dispersed across the other documentation pages http://jshint.com/docs/. You can use the filename as a general guide, but the specific URLs are specified via JSON values declared at the beginning of each file.

— Reply to this email directly or view it on GitHub https://github.com/jshint/jshint.github.io/pull/24#issuecomment-165471559 .