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
Closes: nodejs/nodejs.org#2866
  • Loading branch information
Derek Lewis committed Apr 30, 2020
1 parent d7b02c3 commit 68242dc
Showing 1 changed file with 74 additions and 0 deletions.
74 changes: 74 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,74 @@
---
name: "\U0001F4D7 Open an issue regarding the nodejs.org 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.
If you found a problem with nodejs.org beyond the API reference docs, please
file an issue in our website repo at “https://github.com/nodejs/nodejs.org”.
For the issue title, enter a one-line summary after “doc: ”. If unsure about
something, please do the best you can.
The “✍️” signifies a request for input.
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**: ✍️

## Problem type

<!-- ✍️ Use “[x]” to mark a selection. -->

- [ ] Missing
- [ ] Needed
- [ ] Confusing
- [ ] Didn't work
- [ ] Other (<!-- ? Please specify if chosen. -->)

## Location

_Section of the site where the content lives (or should)._

Affected URL(s):

- https://nodejs.org/api/✍️

## Reproduction procedure

_Steps to reproduce the problem_

✍️

## Expected behavior/code

_What you were expecting._

✍️

## Additional information

_Any other information that would be helpful to solve this._

<!-- ? Enter “n/a” if enough details exist elsewhere in this template. -->

✍️

---

<!-- ? 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 68242dc

Please sign in to comment.