|
| 1 | +--- |
| 2 | +name: "\U0001F4D7 Open an issue regarding the Node.js API reference docs" |
| 3 | +about: Let us know about any problematic API reference documents |
| 4 | +title: "doc: " |
| 5 | +labels: doc |
| 6 | +--- |
| 7 | + |
| 8 | +# 📗 API Reference Docs Problem |
| 9 | + |
| 10 | +<!------------------------------------------------------------------------------ |
| 11 | +Thank you for wanting to make nodejs.org better! |
| 12 | +
|
| 13 | +This template is for issues with the Node.js API reference docs. |
| 14 | +
|
| 15 | +For more general support, please open an issue in |
| 16 | +our help repo at “https://github.com/nodejs/help”. |
| 17 | +
|
| 18 | +For the issue title, enter a one-line summary after “doc: ”. |
| 19 | +The “✍️” signifies a request for input. If unsure, do the best you can. |
| 20 | +
|
| 21 | +If you found a problem with nodejs.org beyond the API reference docs, please |
| 22 | +open an issue in our website repo at “https://github.com/nodejs/nodejs.org”. |
| 23 | +-------------------------------------------------------------------------------> |
| 24 | + |
| 25 | +<!-- |
| 26 | +Version: output of “node -v” |
| 27 | +Platform: output of “uname -a” (UNIX), or version and 32 or 64-bit (Windows) |
| 28 | +Subsystem: if known, please specify affected core module name |
| 29 | +--> |
| 30 | + |
| 31 | +- **Version**: ✍️ |
| 32 | +- **Platform**: ✍️ |
| 33 | +- **Subsystem**: ✍️ |
| 34 | + |
| 35 | +## Location |
| 36 | + |
| 37 | +_Section of the site where the content exists_ |
| 38 | + |
| 39 | +Affected URL(s): |
| 40 | +- https://nodejs.org/api/✍️ |
| 41 | + |
| 42 | +## Problem description |
| 43 | + |
| 44 | +_Concise explanation of what you found to be problematic_ |
| 45 | + |
| 46 | +<!-- If applicable, include any screenshots that may help solve the problem. --> |
| 47 | + |
| 48 | +✍️ |
| 49 | + |
| 50 | +--- |
| 51 | + |
| 52 | +<!-- Use “[x]” to check the box below if interested in contributing. --> |
| 53 | + |
| 54 | +- [ ] I would like to work on this issue and submit a pull request. |