1# Copyright 2023 Google LLC
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7# https://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15name: 📝 Documentation Issue
16description: Report wrong or missing information with the documentation in this repo.
17title: "Brief summary of what is missing or incorrect"
18labels: ["type: docs"]
19body:
20 - type: markdown
21 attributes:
22 value: |
23 Thanks for stopping by to let us know something could be better! :smile:
24
25 Please explain below how we can improve our documentation.
26 - type: textarea
27 id: description
28 attributes:
29 label: Description
30 description: "Provide a short description of what is missing or incorrect, as well as a link to the specific location of the issue."
31 validations:
32 required: true
33 - type: textarea
34 id: potential-solution
35 attributes:
36 label: Potential Solution
37 description: "What would you prefer the documentation say? Why would this information be more accurate or helpful?"
38 - type: textarea
39 id: additional-details
40 attributes:
41 label: Additional Details
42 description: "Please reference any other relevant issues, PRs, descriptions, or screenshots here."
View as plain text