-
Notifications
You must be signed in to change notification settings - Fork 30.1k
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
meta: add issue template for API reference docs #32944
meta: add issue template for API reference docs #32944
Conversation
/cc @nodejs/documentation @mcollina @codebytere for review please |
/cc @Trott as we may need to start linting these Markdown files |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree that this merits its own template - but this as it stands seems to be geared towards an issue grounded in Node.js behavior rather than docs. Can we perhaps remove the sections which would likely not come into play in a docs context?
Prior to this commit, there was no GitHub issue template guiding users to open issues about gaps in the API reference docs. Refs: #31123 Closes: nodejs/nodejs.org#2866
@codebytere, your feedback has been incorporated. The potentially unnecessary sections have been removed, which was made possible by slightly modifying the final section to allow for more free-form commentary. |
Prior to this commit, there was no GitHub issue template guiding users to open issues about gaps in the API reference docs. Refs: #31123 PR-URL: #32944 Fixes: nodejs/nodejs.org#2866 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Shelley Vohr <codebytere@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Landed in 3226731 |
Prior to this commit, there was no GitHub issue template guiding users to open issues about gaps in the API reference docs. Refs: #31123 PR-URL: #32944 Fixes: nodejs/nodejs.org#2866 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Shelley Vohr <codebytere@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Prior to this commit, there was no GitHub issue template guiding users to open issues about gaps in the API reference docs. Refs: #31123 PR-URL: #32944 Fixes: nodejs/nodejs.org#2866 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Shelley Vohr <codebytere@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Prior to this commit, there was no GitHub issue template guiding
users to open issues about gaps in the API reference docs.
Refs: #31123
Closes: nodejs/nodejs.org#2866
Checklist