[Merged by Bors] - Cleanup of Markdown Files and add CI Checking#1463
[Merged by Bors] - Cleanup of Markdown Files and add CI Checking#1463MinerSebas wants to merge 18 commits intobevyengine:mainfrom
Conversation
|
It would be nice to add this to the CI as well somehow, to avoid the churn of making commits like this periodically. |
|
I have added super-linter Github Action to check the Files. Other Linters that could be applicable here are As for the previously ignored Markdown Rules, they are now either fixed or explicitly marked as to ignore. Edit: |
CleanCut
left a comment
There was a problem hiding this comment.
Nice work. This looks like a good step in getting and keeping the markdown files clean. I especially like the random typos you caught and fixed in the process.
I have some suggestions I think would improve this even more, mostly based on my experience with GitHub Actions for CI. However, I'm not the gatekeeper and defer to @cart's preferences. 😄
|
I added Documentation for the used Linters in the new The description for Clippy and rustfmt are lackluster because I was unsure what else to write, but I am open for suggestions. |
a166275 to
f561720
Compare
…le-trailing-newline
f561720 to
46d3c8a
Compare
|
This looks good to me. I'm not the biggest fan of forcing "semantically correct" header types ( |
|
bors r+ |
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!".
|
Pull request successfully merged into main. Build succeeded: |
Update `linters.md` with info about `cargo ci` xtask as per #1463 (review) Co-authored-by: Carter Anderson <mcanders1@gmail.com>
Update `linters.md` with info about `cargo ci` xtask as per bevyengine#1463 (review) Co-authored-by: Carter Anderson <mcanders1@gmail.com>
Update `linters.md` with info about `cargo ci` xtask as per bevyengine#1463 (review) Co-authored-by: Carter Anderson <mcanders1@gmail.com>
I have run the VSCode Extension 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:
MD036/no-emphasis-as-heading:This Warning only Appears in the Github Issue Templates and can be ignored.MD041/first-line-headingOnly 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:
The explanation for each case, where it isn't Alphabetical :