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 #7

Open
thibaudcolas opened this issue Sep 30, 2018 · 1 comment
Open

Add automated documentation generation #7

thibaudcolas opened this issue Sep 30, 2018 · 1 comment
Labels
enhancement New feature or request good first issue Good for newcomers 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. 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 30, 2018
@thibaudcolas thibaudcolas added this to the Nice to have milestone Sep 30, 2018
@thibaudcolas
Copy link
Owner Author

See thibaudcolas/draftjs-filters#19, thibaudcolas/draftjs-filters#26 for a solution.

@thibaudcolas thibaudcolas removed the hacktoberfest https://hacktoberfest.digitalocean.com/ label Jun 5, 2019
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 help wanted Extra attention is needed
Projects
None yet
Milestone
Nice to have
Development

No branches or pull requests
1 participant
@thibaudcolas