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

README API documentation overhaul #441

Closed
Tracked by #674
ncb000gt opened this issue Sep 25, 2019 · 8 comments · Fixed by #716
Closed
Tracked by #674

README API documentation overhaul #441

ncb000gt opened this issue Sep 25, 2019 · 8 comments · Fixed by #716
Labels
hacktoberfest This issue is registered for Hacktoberfest! help wanted Extra attention is needed released status:ready Ready to start implementation type:docs Improvements or additions to documentation

Comments

@ncb000gt
Copy link
Member

The API documentation hasn't changed much since I threw it together with the original module. Clearer documentation has always been a source of irritation for users.
@ncb000gt ncb000gt added the hacktoberfest This issue is registered for Hacktoberfest! label Sep 25, 2019
@ncb000gt
Copy link
Member Author

That would be great. Thanks!

@balajipachai
Copy link

One quick question: reworking the API documentation does it imply, changing it in the API section/ adding code examples in the README section?

@ncb000gt
Copy link
Member Author

@balajipachai yes. Right now it's too condensed and kind of hard to read unless you know it well. The readme itself isn't broken out well.

An example of something I'm looking for is something like: https://github.com/RobinBuschmann/sequelize-typescript

@keplerk
Copy link

keplerk commented Dec 19, 2019

Indeed that would be nice, thumbs up for this

@nmay231
Copy link
Contributor

nmay231 commented Feb 1, 2020

Another thing that could be done is to host the example docs on something like github.io or gitbook (premium is free for open-source projects) and then get a domain from js.org. Both cron.js.org and node-cron.js.org are available.

Don't know if it's something you want to do for this project, but it's an idea. 🤷‍♂️

@ncb000gt
Copy link
Member Author

ncb000gt commented Feb 3, 2020 via email

@sheerlox sheerlox mentioned this issue Jun 26, 2023
Open
34 tasks
@sheerlox sheerlox added type:feature New feature or feature improvement & requests type:docs Improvements or additions to documentation and removed hacktoberfest This issue is registered for Hacktoberfest! type:feature New feature or feature improvement & requests labels Aug 15, 2023
@sheerlox
Copy link
Collaborator

sheerlox commented Sep 8, 2023 •
edited
Loading

some good project READMEs to use as inspiration:

cc @rharshit82

@sheerlox sheerlox changed the title Rework the API Documentation so that it's more clear. Rework the API Documentation so that it's more clear Sep 8, 2023
@sheerlox sheerlox changed the title Rework the API Documentation so that it's more clear README API documentation overhaul Sep 8, 2023
@sheerlox sheerlox added hacktoberfest This issue is registered for Hacktoberfest! status:ready Ready to start implementation labels Sep 30, 2023
@sheerlox sheerlox added the help wanted Extra attention is needed label Oct 12, 2023
@sheerlox sheerlox mentioned this issue Oct 25, 2023
Merged
9 tasks
@ncb000gt
Copy link
Member Author

🎉 This issue has been resolved in version 3.1.5 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
hacktoberfest This issue is registered for Hacktoberfest! help wanted Extra attention is needed released status:ready Ready to start implementation type:docs Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(readme): API documentation overhaul rharshit82/node-cron
5 participants
@ncb000gt @keplerk @sheerlox @balajipachai @nmay231