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
Missing Documentation #1400
Comments
Also breaking changes if any ... nevermnif found here .. but would love it on the site |
@essuraj absolutely. This probably belongs under the guides sidebar in docs. Submitting a PR now 😄 @stevehipwell thank you for helping us find short-comings in the documentation ❤️ we shipped knowing there were gaps but we have far more work on the project than maintainers can tackle at the moment, though our team is growing 🎉. Our hope in shipping the code base was that the community would help us identify and fill in the gaps. Before the 5.x release, we didn't have a great process for accepting documentation contributions from the community. I prioritized the new website so that we had a solid process to accept documentation contributions 😄 the docs in this repo (under ./docs) are used to populate the Docs tab on the new website so a simple PR agains those will result in the website being updated. Keeping issues and PRs on this repo flowing has taken up a majority of my time post-release. I probably won't get to a documentation deep dive for a few weeks. Between now and then, possibly one of the community members or another maintainer will have a few cycles to help out on this ❤️ |
@retrohacker - I have tried to figure out what was part of the |
@stevehipwell thank you for all of the time you are investing in helping the restify TypeScript community <3 Are the JSDoc type definitions enough for what you need? Each function should have them. I.E. https://github.com/restify/node-restify/blob/5.x/lib/server.js#L70-L71 |
@retrohacker - That's my pleasure, I'm a big fan of restify and want to make it the first choice TypeScript REST API for node. The JSDoc type definitions are great for the functions but I really need to know what values (e.g. |
I believe we have a convention of prepending It should be safe to assume that properties without a prepended underscore and/or the |
👍 |
@stevehipwell take a look to the new JSDoc based documentation it should contain all the parameters with types: https://github.com/restify/node-restify/tree/master/docs/_api |
Thanks @hekike |
🎉 you are amazing @hekike, thank you! |
The current v5 documentation is an improvement on what we had before but it still isn't good enough for me to write the new TypeScript definitions from.
Documentation issues:
server.version
to beserver.versions
Missing documentation:
The text was updated successfully, but these errors were encountered: