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.

Sign up for GitHub

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

Jump to bottom

Add automated documentation generation #19

Closed
thibaudcolas opened this issue Sep 28, 2018 · 3 comments
Closed

Add automated documentation generation #19

thibaudcolas opened this issue Sep 28, 2018 · 3 comments
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest https://hacktoberfest.digitalocean.com/ help wanted Extra attention is needed
Milestone
Nice to have

Comments

@thibaudcolas
Copy link
Owner

At the moment, the project's documentation is limited to what is in the README, and a short note about filtering limitation in docs/. It would be nice if there was more complete documentation generated automatically: a full API reference, with links back to the source code, based on the Flow types (or JSDoc).

Ideally this would be generating Markdown so it can be versioned with the code in Git/GitHub.

Tools to consider & useful info:
@thibaudcolas thibaudcolas added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers hacktoberfest https://hacktoberfest.digitalocean.com/ labels Sep 28, 2018
@thibaudcolas thibaudcolas added this to the Nice to have milestone Sep 28, 2018
@rjseymour66
Copy link

Hi,
I am a professional technical writer and am eager to contribute to my first Github project.

I keep seeing JSDoc being discussed for similar projects, so I think that sounds as good as any solution. Would you like me to help?

  • Ryan

@thibaudcolas
Copy link
Owner Author

Hey @rjseymour66, thank you for offering your help! Someone else has already had a shot at this (#26), so I think I'll go with their implementation.

Generally JSDoc would be a very good fit for such use case, but here the project already has annotations with Flow so it would be even better if the documentation generator used these.

@nazimjamil nazimjamil mentioned this issue Jan 22, 2019
Merged
thibaudcolas added a commit to nazimjamil/draftjs-filters that referenced this issue Jan 22, 2019
@thibaudcolas
fix(api): auto-update API docs in README. Fix thibaudcolas#19 (thibau…
e48dd7f 
…dcolas#26)
thibaudcolas added a commit to nazimjamil/draftjs-filters that referenced this issue Jan 22, 2019
@thibaudcolas
fix(api): auto-update API docs in README. Fix thibaudcolas#19 (thibau…
b01cc4c 
…dcolas#26)
thibaudcolas pushed a commit to nazimjamil/draftjs-filters that referenced this issue Jan 22, 2019
@nazimjamil @thibaudcolas
fix(api): auto-generate documentation using flow types. Fix thibaudco…
bc7a4f8 
…las#19 (thibaudcolas#26)
thibaudcolas pushed a commit that referenced this issue Jan 23, 2019
@nazimjamil @thibaudcolas
fix(api): auto-generate documentation using flow types. Fix #19 (#26)
a2da323
thibaudcolas added a commit that referenced this issue Jan 23, 2019
@thibaudcolas @semantic-release-bot
chore(release): v2.2.1 [skip ci]
428f7f7 
## [2.2.1](v2.2.0...v2.2.1) (2019-01-23)

### Bug Fixes

* **api:** auto-generate documentation using flow types. Fix [#19](#19) ([#26](#26)) ([a2da323](a2da323))
* **api:** auto-update API docs in README ([aa40707](aa40707))
@thibaudcolas
Copy link
Owner Author

🎉 This issue is fixed in v2.2.1, available on npm: draftjs-filters@2.2.1.

Generated by 📦🚀 semantic-release

@thibaudcolas thibaudcolas mentioned this issue Jan 24, 2019
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest https://hacktoberfest.digitalocean.com/ help wanted Extra attention is needed
Projects
None yet
Milestone
Nice to have
Development

No branches or pull requests
2 participants
@thibaudcolas @rjseymour66