Skip to content

Commit

Permalink
[docs] Fix missing issue template (#3026)
Browse files Browse the repository at this point in the history
  • Loading branch information
oliviertassinari authored Dec 24, 2023
1 parent 5965a33 commit edbf381
Show file tree
Hide file tree
Showing 2 changed files with 54 additions and 0 deletions.
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/4.docs-feedback.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Docs feedback
description: Improve documentation about MUI Toolpad.
labels: ['status: waiting for maintainer', 'support: docs-feedback']
title: '[docs] '
body:
- type: markdown
attributes:
value: |
Please provide a searchable summary of the issue in the title above ⬆️.
Thanks for contributing by creating an issue! ❤️
- type: input
attributes:
label: Search keywords
description: Your issue may have already been reported! List the keywords you've used to search the [existing issues](https://github.com/mui/mui-toolpad/issues). This will also make your issue searchable for others.
placeholder: e.g. datagrid column resizing
validations:
required: true

- type: input
id: page-url
attributes:
label: Related page
description: Which page of the documentation is this about?
placeholder: https://mui.com/toolpad/
validations:
required: true

- type: dropdown
attributes:
label: Kind of issue
description: What kind of problem are you facing?
options:
- Unclear explanations
- Missing information
- Broken demo
- Other
validations:
required: true

- type: textarea
attributes:
label: Issue description
description: |
Let us know what went wrong when you were using this documentation and what we could do to improve it.
value: |
I was looking for ... and it appears that ...
- type: textarea
attributes:
label: Context 🔦
description: What are you trying to accomplish? What brought you to this page? Your context can help us to come up with solutions that benefit the community as a whole.
1 change: 1 addition & 0 deletions docs/next.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ export default withDocsInfra(
// SOURCE_CODE_ROOT_URL: 'https://github.com/mui/mui-toolpad/blob/master',
SOURCE_CODE_REPO: 'https://github.com/mui/mui-toolpad',
SOURCE_GITHUB_BRANCH: 'master',
GITHUB_TEMPLATE_DOCS_FEEDBACK: '4.docs-feedback.yml',
},
webpack: (config, options) => {
return {
Expand Down

0 comments on commit edbf381

Please sign in to comment.