Skip to content

Fork usejsdoc.org ? #501

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

Closed
ephys opened this issue Aug 23, 2016 · 3 comments
Closed

Fork usejsdoc.org ? #501

ephys opened this issue Aug 23, 2016 · 3 comments

Comments

@ephys
Copy link

ephys commented Aug 23, 2016

JSDoc has been extremely slow to define standards on how to document the new ES features. It also seems more and more likely that the project is no longer being maintained.

In the meantime, the JavaScript community is still left with no clear way to document async, Promises, destructured arguments, and much more.

I think it might be time to fork https://github.com/jsdoc3/jsdoc3.github.com and create a place where these new features can be discussed by the community, standardised, and documented. It would also be a good opportunity to update the examples provided by usejsdoc.org by adding versions that use the new ES syntaxes.

documentationjs looks really promising and is already tackling a large amount of issues jsdoc has left unanswered. Imo it seems like this project would be a good fit for that task.

What do you think ?

@tmcw
Copy link
Member

tmcw commented Aug 24, 2016

Yep! I'd love to get great documentation-documentation online. We still have a bunch of tags to implement #9 since there are lots and many are kind of non-essential - so I guess we could indicate support on the site. Is this something you'd be interested in helping out with?

@ephys
Copy link
Author

ephys commented Aug 25, 2016

I'd definitely like to help out. Do you have a list of things you want done? I can start working on them as soon as you have a repository set up and ready to accept PRs.

@tmcw
Copy link
Member

tmcw commented Jul 31, 2017

Per documentation direction, for post-documentation-js work, I'm not planning on adopting the JSDoc project, and don't really have the time & energy to maintain usejsdoc.org. I will be pushing for a simplified, modernized documentation standard, but it won't be backwards-compatible with JSDoc.

That said, if anyone does want to adopt JSDoc or help them out, please do! There's lots of utility there, and the maintainers would much appreciate the help.

@tmcw tmcw closed this as completed Jul 31, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants