-
-
Notifications
You must be signed in to change notification settings - Fork 31.9k
meta: add issue template for API reference docs #32944
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
Closed
DerekNonGeneric
wants to merge
3
commits into
nodejs:master
from
DerekNonGeneric:feat/api-ref-docs-issue-template
Closed
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
--- | ||
name: "\U0001F4D7 Open an issue regarding the Node.js API reference docs" | ||
about: Let us know about any problematic API reference documents | ||
title: "doc: " | ||
labels: doc | ||
--- | ||
|
||
# 📗 API Reference Docs Problem | ||
|
||
<!------------------------------------------------------------------------------ | ||
Thank you for wanting to make nodejs.org better! | ||
|
||
This template is for issues with the Node.js API reference docs. | ||
|
||
For more general support, please open an issue in | ||
our help repo at “https://github.com/nodejs/help”. | ||
|
||
For the issue title, enter a one-line summary after “doc: ”. | ||
The “✍️” signifies a request for input. If unsure, do the best you can. | ||
|
||
If you found a problem with nodejs.org beyond the API reference docs, please | ||
open an issue in our website repo at “https://github.com/nodejs/nodejs.org”. | ||
-------------------------------------------------------------------------------> | ||
|
||
<!-- | ||
Version: output of “node -v” | ||
Platform: output of “uname -a” (UNIX), or version and 32 or 64-bit (Windows) | ||
Subsystem: if known, please specify affected core module name | ||
--> | ||
|
||
- **Version**: ✍️ | ||
- **Platform**: ✍️ | ||
- **Subsystem**: ✍️ | ||
|
||
## Location | ||
|
||
_Section of the site where the content exists_ | ||
|
||
Affected URL(s): | ||
- https://nodejs.org/api/✍️ | ||
|
||
## Problem description | ||
|
||
_Concise explanation of what you found to be problematic_ | ||
|
||
<!-- If applicable, include any screenshots that may help solve the problem. --> | ||
|
||
✍️ | ||
|
||
--- | ||
|
||
<!-- Use “[x]” to check the box below if interested in contributing. --> | ||
|
||
- [ ] I would like to work on this issue and submit a pull request. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.