Commit graph

5 commits

Author SHA1 Message Date
Alice Cecile
203c7c1aca Issue template for documentation improvements (#1732)
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.
2021-04-13 20:18:54 +00:00
MinerSebas
c9f19d8663 Cleanup of Markdown Files and add CI Checking (#1463)
I have run the VSCode Extension [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) on all Markdown Files in the Repo.
The provided Rules are documented here: https://github.com/DavidAnson/markdownlint/blob/v0.23.1/doc/Rules.md

Rules I didn't follow/fix:
* MD024/no-duplicate-heading
  * Changelog: Here Heading will always repeat.
  * Examples Readme: Platform-specific documentation should be symmetrical.
* MD025/single-title
* MD026/no-trailing-punctuation
  * Caused by the ! in "Hello, World!".
* MD033/no-inline-html
  * The plugins_guidlines file does need HTML, so the shown badges aren't downscaled too much.
* ~~MD036/no-emphasis-as-heading:~~
  * ~~This Warning only Appears in the Github Issue Templates and can be ignored.~~
* ~~MD041/first-line-heading~~
  * ~~Only appears in the Readme for the AlienCake example Assets, which is unimportant.~~

---

I also sorted the Examples in the Readme and Cargo.toml in this order/Priority:
* Topic/Folder
* Introductionary Examples
* Alphabetical Order

The explanation for each case, where it isn't Alphabetical :
* Diagnostics
  * log_diagnostics: The usage of inbuild Diagnostics is more important than creating your own.
* ECS (Entity Component System)
  * ecs_guide: The guide should be read, before diving into other Features.
* Reflection
  * reflection: Basic Explanation should be read, before more advanced Topics.
* WASM Examples
  * hello_wasm: It's "Hello, World!".
2021-02-22 04:50:05 +00:00
Théo Degioanni
b324f66135
removed default labels in github issues (#825) 2020-11-09 11:45:58 -08:00
iMplode nZ
0db9e9494d
Regularized Issue Templates so that the grammar is always the same. (#787)
* Regularized Issue Templates so that the grammar is always the same.

* Update bug_report.md

Co-authored-by: Carter Anderson <mcanders1@gmail.com>
2020-11-04 16:38:05 -08:00
Logan Magee
90ea5b1e6b
Add issue and pull request templates (#551) 2020-10-15 13:47:23 -07:00