The existing issue templates don't fit well for "the docs are not very good" and are too high friction. This is intended as a very-low friction tool to provide the basis for more thorough docs PRs.
14 lines
560 B
Markdown
14 lines
560 B
Markdown
---
|
|
name: Docs Improvement
|
|
about: Help us write better docs to catch common issues!
|
|
title: ''
|
|
labels: documentation, needs-triage
|
|
assignees: ''
|
|
---
|
|
|
|
## How can Bevy's documentation be improved?
|
|
|
|
Provide a link to the documentation and describe how it could be improved. In what ways is it incomplete, incorrect, or misleading?
|
|
|
|
If you have suggestions on exactly what the new docs should say, feel free to include them here. Or alternatively, make the changes yourself and [create a pull request](https://bevyengine.org/learn/book/contributing/code/) instead.
|