Skip to content

Commit

Permalink
meta: add issue template for API reference docs
Browse files Browse the repository at this point in the history
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 <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Gireesh Punathil <[email protected]>
Reviewed-By: Shelley Vohr <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Derek Lewis authored and codebytere committed May 11, 2020

Verified

This commit was signed with the committer’s verified signature.
codebytere Shelley Vohr
1 parent 94d0a08 commit 0a78925
Showing 1 changed file with 54 additions and 0 deletions.
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/3-api-ref-docs-problem.md
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.

0 comments on commit 0a78925

Please sign in to comment.