Skip to content

Commit c9f19d8

Browse files
committed
Cleanup of Markdown Files and add CI Checking (bevyengine#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!".
1 parent e5b0c65 commit c9f19d8

File tree

18 files changed

+220
-121
lines changed

18 files changed

+220
-121
lines changed

.github/CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Contributing
22

33
Please see the [Contributing Code](https://bevyengine.org/learn/book/contributing/code/) section of
4-
[The Book](https://bevyengine.org/learn/book/introduction/).
4+
[The Book](https://bevyengine.org/learn/book/introduction/).

.github/ISSUE_TEMPLATE/bug_report.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,27 @@ labels: ''
66
assignees: ''
77
---
88

9-
**Bevy version**
9+
## Bevy version
1010

1111
The release number or commit hash of the version you're using.
1212

13-
**Operating system & version**
13+
## Operating system & version
1414

1515
Ex: Windows 10, Ubuntu 18.04, iOS 14.
1616

17-
**What you did**
17+
## What you did
1818

1919
The steps you took to uncover this bug. Please list full reproduction steps if
2020
feasible.
2121

22-
**What you expected to happen**
22+
## What you expected to happen
2323

2424
What you think should've happened if everything was working properly.
2525

26-
**What actually happened**
26+
## What actually happened
2727

2828
The actual result of the actions you described.
2929

30-
**Additional information**
30+
## Additional information
3131

3232
Any additional information you would like to add such as screenshots, logs, etc.

.github/ISSUE_TEMPLATE/feature_request.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,19 @@ labels: ''
66
assignees: ''
77
---
88

9-
**What problem does this solve or what need does it fill?**
9+
## What problem does this solve or what need does it fill?
1010

1111
A description of why this particular feature should be added.
1212

13-
**What solution would you like?**
13+
## What solution would you like?
1414

1515
The solution you propose for the problem presented.
1616

17-
**What alternative(s) have you considered?**
17+
## What alternative(s) have you considered?
1818

1919
Other solutions to solve and/or work around the problem presented.
2020

21-
**Additional context**
21+
## Additional context
2222

2323
Any other information you would like to add such as related previous work,
2424
screenshots, benchmarks, etc.

.github/bors.toml

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ status = [
66
"build-wasm (stable, ubuntu-latest)",
77
"build-wasm (nightly, ubuntu-latest)",
88
"build-android",
9+
"markdownlint",
910
]
1011

1112
use_squash_merge = true

.github/linters/.markdown-lint.yml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"MD013": false
3+
}

.github/workflows/ci.yml

+19-2
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ jobs:
3737
run: cargo fmt --all -- --check
3838
if: runner.os == 'linux' && matrix.toolchain == 'stable'
3939

40-
# type complexity must be ignored because we use huge templates for queries
41-
# -A clippy::manual-strip: strip_prefix support was added in 1.45. we want to support earlier rust versions
40+
# -A clippy::type_complexity: type complexity must be ignored because we use huge templates for queries.
41+
# -A clippy::manual-strip: strip_prefix support was added in 1.45. We want to support earlier rust versions.
4242
- name: Clippy
4343
run: cargo clippy --all-targets --all-features -- -D warnings -A clippy::type_complexity -A clippy::manual-strip
4444
if: runner.os == 'linux' && matrix.toolchain == 'stable'
@@ -80,3 +80,20 @@ jobs:
8080
run: cargo install cargo-apk
8181
- name: Build APK
8282
run: cargo apk build --example android
83+
84+
markdownlint:
85+
runs-on: ubuntu-latest
86+
steps:
87+
- uses: actions/checkout@v2
88+
with:
89+
# Full git history is needed to get a proper list of changed files within `super-linter`
90+
fetch-depth: 0
91+
92+
- name: Run Markdown Lint
93+
uses: github/super-linter@v3
94+
env:
95+
VALIDATE_ALL_CODEBASE: false
96+
VALIDATE_MARKDOWN: true
97+
DEFAULT_BRANCH: master
98+
# Not needed here as only one Linter is used.
99+
#GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CHANGELOG.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
<!-- MD024 - We want repeated headings in a changelog file -->
2+
<!-- markdownlint-disable-file MD024 -->
3+
14
# Changelog
25

36
While we try to keep the `Unreleased` changes updated, it is often behind and does not include
@@ -6,16 +9,16 @@ current changes on git with [previous release tags][git_tag_comparison].
69

710
[git_tag_comparison]: https://github.com/bevyengine/bevy/compare/v0.4.0...main
811

9-
1012
## Version 0.4.0 (2020-12-19)
1113

1214
### Added
15+
1316
- [add bevymark benchmark example][273]
14-
- [gltf: support camera and fix hierarchy][772]
17+
- [gltf: support camera and fix hierarchy][772]
1518
- [Add tracing spans to schedules, stages, systems][789]
1619
- [add example that represents contributors as bevy icons][801]
1720
- [Add received character][805]
18-
- [Add bevy_dylib to force dynamic linking of bevy][808]
21+
- [Add bevy_dylib to force dynamic linking of bevy][808]
1922
- [Added RenderPass::set_scissor_rect][815]
2023
- [`bevy_log`][836]
2124
- Adds logging functionality as a Plugin.
@@ -33,7 +36,7 @@ current changes on git with [previous release tags][git_tag_comparison].
3336
- Replaces the properties system
3437
- [Add support for Apple Silicon][928]
3538
- [Live reloading of shaders][937]
36-
- [ Store mouse cursor position in Window][940]
39+
- [Store mouse cursor position in Window][940]
3740
- [Add removal_detection example][945]
3841
- [Additional vertex attribute value types][946]
3942
- [Added WindowFocused event][956]
@@ -46,9 +49,9 @@ current changes on git with [previous release tags][git_tag_comparison].
4649

4750
### Changed
4851

49-
- [delegate layout reflection to RenderResourceContext][691]
52+
- [delegate layout reflection to RenderResourceContext][691]
5053
- [Fall back to remove components one by one when failing to remove a bundle][719]
51-
- [Port hecs derive macro improvements][761]
54+
- [Port hecs derive macro improvements][761]
5255
- [Use glyph_brush_layout and add text alignment support][765]
5356
- [upgrade glam and hexasphere][791]
5457
- [Flexible ECS Params][798]
@@ -242,7 +245,7 @@ current changes on git with [previous release tags][git_tag_comparison].
242245
- [`FrameTimeDiagnosticsPlugin` now shows "frame count" in addition to "frame time" and "fps"][678]
243246
- [Add hierarchy example][565]
244247
- [`WgpuPowerOptions` for choosing between low power, high performance, and adaptive power][397]
245-
- Derive `Debug` for more types: [#597][597], [#632][632]
248+
- Derive `Debug` for more types: [#597][597], [#632][632]
246249
- Index buffer specialization
247250
- [Allows the use of U32 indices in Mesh index buffers in addition to the usual U16 indices][568]
248251
- [Switch to u32 indices by default][572]
@@ -286,7 +289,7 @@ current changes on git with [previous release tags][git_tag_comparison].
286289
- [Migrated to Rodio 0.12][692]
287290
- New method of playing audio can be found in the examples.
288291
- Added support for inserting custom initial values for `Local<T>` system resources [#745][745]
289-
292+
290293
### Fixed
291294

292295
- [Properly update bind group ids when setting dynamic bindings][560]
@@ -359,7 +362,6 @@ current changes on git with [previous release tags][git_tag_comparison].
359362
[745]: https://github.com/bevyengine/bevy/pull/745
360363
[752]: https://github.com/bevyengine/bevy/pull/752
361364

362-
363365
## Version 0.2.1 (2020-9-20)
364366

365367
### Fixed

CREDITS.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@
55
* hecs
66
* legion_transform
77
* wgpu-rs examples
8-
* yaks: ArchetypeSet, borrowed some ideas from their scheduler implementation
8+
* yaks: ArchetypeSet, borrowed some ideas from their scheduler implementation
99

1010
## Inspiration
1111

1212
* game engines: amethyst, coffee
13-
* ecs: legion, shipyard, yaks
13+
* ecs: legion, shipyard, yaks
1414

1515
## Assets
1616

1717
* Generic RPG Pack (CC0 license) by [Bakudas](https://twitter.com/bakudas) and [Gabe Fern](https://twitter.com/_Gabrielfer)
18-
* Environment maps (`.hdr` files) from [HDRIHaven](https://hdrihaven.com) (CC0 license)
18+
* Environment maps (`.hdr` files) from [HDRIHaven](https://hdrihaven.com) (CC0 license)

0 commit comments

Comments
 (0)