Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add issue and discussion templates for documentation improvements #2619

Merged
merged 1 commit into from
Nov 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .github/DISCUSSION_TEMPLATE/docs-suggestions.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
body:
- type: markdown
attributes:
value: |
Thank you for getting in touch! Please fill out this form as completely as possible.

Want to report a problem with the Starlight docs? [Open a new issue](https://github.com/withastro/starlight/issues/new?assignees=&labels=&projects=&template=---02-docs-issue.yml)
Want to chat before posting? [Join us in the `#starlight` channel on Discord](https://astro.build/chat)
- type: textarea
id: summary
attributes:
label: What is your idea?
description: A brief, one or two sentence description of your idea for how to improve the Starlight docs.
validations:
required: true
- type: textarea
id: background
attributes:
label: Why is this important?
description: Explain why this idea is valuable. What problems would it solve? Which users would it help?
validations:
required: true
- type: textarea
id: prior-art
attributes:
label: How does your idea relate to existing docs content?
description: Are there specific pages you would like to change? Or existing pages that are related to your proposal?
placeholder: |
- Example
- Example
- Example
- type: checkboxes
id: will-pr
attributes:
label: Participation
description: Let us know if your interested in contributing this feature yourself.
options:
- label: I am willing to submit a pull request for this feature.
required: false
45 changes: 45 additions & 0 deletions .github/ISSUE_TEMPLATE/---02-docs-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: "\U0001F4DA Docs Issue"
description: Report an issue with the Starlight documentation
labels: []
assignees: []
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to let us know something is wrong! Please fill out this form as completely as possible.
- type: input
id: docs-page
attributes:
label: What page of the docs did you find an issue on?
description: If this issue applies to multiple pages, include additional pages in your bug description.
placeholder: https://starlight.astro.build/...
validations:
required: true
- type: textarea
id: bug-description
attributes:
label: Describe the issue
description: A clear and concise description of what the issue is.
validations:
required: true
- type: input
id: os
attributes:
label: What operating system are you using?
placeholder: Mac, Windows, Linux
validations:
required: true
- type: input
id: browser
attributes:
label: What browser are you using?
placeholder: Chrome, Firefox, Safari
validations:
required: true
- type: checkboxes
id: will-pr
attributes:
label: Participation
options:
- label: I am willing to submit a pull request for this issue.
required: false
Loading