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

Improve docs for the jsdoc-plugins package #7132

Closed
ma2ciek opened this issue Dec 5, 2018 · 1 comment
Closed

Improve docs for the jsdoc-plugins package #7132

ma2ciek opened this issue Dec 5, 2018 · 1 comment
Labels
package:dev type:docs This issue reports a task related to documentation (e.g. an idea for a guide).
Milestone

Comments

@ma2ciek
Copy link
Contributor

ma2ciek commented Dec 5, 2018

This package gets some traffic (#456).

We can try to improved these docs in the following way:

  • List all available plugins, write which package handles which problem and if the package is CKEditor 5 related or not.
  • Think of some better error messages. We can list these error messages with potential solutions.
  • Create a TOC
  • Link TODO to GH issues
  • Improve the usage guide, write about some differences between our approach to writing docs and docs found in the http://usejsdoc.org/.
@ma2ciek
Copy link
Contributor Author

ma2ciek commented Dec 5, 2018

We could also link to the umberto project as a potential package to be used later.

@ma2ciek ma2ciek changed the title Improve docs in the jsdoc-plugins package Improve docs for the jsdoc-plugins package Dec 6, 2018
Reinmar referenced this issue in ckeditor/ckeditor5-dev Jan 23, 2019
Docs: Improved docs for JSDoc plugins. Closes #460.
@mlewand mlewand transferred this issue from ckeditor/ckeditor5-dev May 18, 2020
@mlewand mlewand added this to the iteration 22 milestone May 18, 2020
@mlewand mlewand added type:docs This issue reports a task related to documentation (e.g. an idea for a guide). package:dev labels May 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package:dev type:docs This issue reports a task related to documentation (e.g. an idea for a guide).
Projects
None yet
Development

No branches or pull requests

2 participants