emfcamp / badge-2024-documentation

Tildagon badge documentation website
https://tildagon.badge.emfcamp.org/
21 stars 38 forks source link

Create python-lint.yml #198

Closed npentrel closed 5 months ago

github-actions[bot] commented 5 months ago

Overall readability score: 71.22 (🟢 +0.07)

File Readability
creating-hexpansions.md 71.46 (🟢 +0)
eeprom.md 76.51 (🟢 +0)
writing-hexpansion-apps.md 69.52 (🟢 +0)
index.md 53.79 (🟢 +0)
development.md 78.52 (🟢 +0)
api.md 63.23 (🟢 +0)
bitmaps.md 54.69 (🟢 +0)
detect-hexpansion.md 57.7 (🟢 +0)
examples.md 98.2 (🟢 +0)
snake.md 83.73 (🟢 +0)
index.md 57.34 (🟢 +0)
publish.md 61.21 (🟢 +0)
badge-hardware.md 83.97 (🟢 +0.2)
ctx.md 79.84 (🟢 +0)
eventbus.md 85.32 (🟢 +0)
reference.md 72.64 (🟢 +0)
ui-elements.md 83.61 (🟢 +2.03)
run-on-badge.md 81.25 (🟢 +0)
simple_tildagon.md 78.82 (🟢 +0)
simulate.md 76.27 (🟢 +0)
badge-tent-volunteering.md 74.86 (🟢 +0)
accessory-ideas.md 68.83 (🟢 +0)
common-problems.md 73.6 (🟢 +0)
flash-the-badge.md 77.8 (🟢 +0)
replacing-parts.md 76.92 (🟢 +0)
View detailed metrics 🟢 - Shows an _increase_ in readability 🔴 - Shows a _decrease_ in readability File | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- [creating-hexpansions.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/hexpansions/creating-hexpansions.md "docs/hexpansions/creating-hexpansions.md") | 71.46 | 62.27 | 9.88 | 10 | 9.51 | 6.42   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [eeprom.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/hexpansions/eeprom.md "docs/hexpansions/eeprom.md") | 76.51 | 67.15 | 7.95 | 8.6 | 9.61 | 6.72   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [writing-hexpansion-apps.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/hexpansions/writing-hexpansion-apps.md "docs/hexpansions/writing-hexpansion-apps.md") | 69.52 | 60.85 | 10.13 | 10.6 | 9.46 | 6.57   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [index.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/index.md "docs/index.md") | 53.79 | 45.15 | 11.2 | 13.7 | 12.64 | 7.29   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [development.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/tildagon-apps/development.md "docs/tildagon-apps/development.md") | 78.52 | 64.61 | 7.96 | 9 | 9.1 | 6   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [api.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/tildagon-apps/examples/api.md "docs/tildagon-apps/examples/api.md") | 63.23 | 60.04 | 10.9 | 11.2 | 9.4 | 7.83   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [bitmaps.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/tildagon-apps/examples/bitmaps.md "docs/tildagon-apps/examples/bitmaps.md") | 54.69 | 39.84 | 10.4 | 12.1 | 12.4 | 7.99   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [detect-hexpansion.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/tildagon-apps/examples/detect-hexpansion.md "docs/tildagon-apps/examples/detect-hexpansion.md") | 57.7 | 63.19 | 11.45 | 10.7 | 11.42 | 8.76   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [examples.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/tildagon-apps/examples/examples.md "docs/tildagon-apps/examples/examples.md") | 98.2 | 100 | 6 | 6 | 6 | 5.46   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [snake.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/tildagon-apps/examples/snake.md "docs/tildagon-apps/examples/snake.md") | 83.73 | 71.44 | 8.02 | 8.5 | 7.77 | 5.51   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [index.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/tildagon-apps/index.md "docs/tildagon-apps/index.md") | 57.34 | 47.99 | 10.73 | 11.7 | 12.17 | 7.69   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [publish.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/tildagon-apps/publish.md "docs/tildagon-apps/publish.md") | 61.21 | 53.71 | 9.81 | 12.6 | 11.25 | 7.27   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [badge-hardware.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/tildagon-apps/reference/badge-hardware.md "docs/tildagon-apps/reference/badge-hardware.md") | 83.97 | 68.97 | 6.9 | 7.2 | 7.98 | 6.4   | 🟢 +0.2 | 🟢 +0.2 | 🟢 +0.08 | 🟢 +0 | 🟢 +0 | 🟢 +0.01 [ctx.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/tildagon-apps/reference/ctx.md "docs/tildagon-apps/reference/ctx.md") | 79.84 | 58.28 | 6.4 | 9.8 | 10.25 | 5.23   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [eventbus.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/tildagon-apps/reference/eventbus.md "docs/tildagon-apps/reference/eventbus.md") | 85.32 | 61.33 | 6 | 7.4 | 8.91 | 5.57   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [reference.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/tildagon-apps/reference/reference.md "docs/tildagon-apps/reference/reference.md") | 72.64 | 60.92 | 7.62 | 7.9 | 9.6 | 8.1   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [ui-elements.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/tildagon-apps/reference/ui-elements.md "docs/tildagon-apps/reference/ui-elements.md") | 83.61 | 60.61 | 6 | 8.1 | 9.43 | 5.52   | 🟢 +2.03 | 🟢 +0.5 | 🟢 +0 | 🟢 +0.7 | 🟢 +0.41 | 🟢 +0.11 [run-on-badge.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/tildagon-apps/run-on-badge.md "docs/tildagon-apps/run-on-badge.md") | 81.25 | 67.96 | 6.9 | 7 | 8.63 | 7   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [simple_tildagon.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/tildagon-apps/simple_tildagon.md "docs/tildagon-apps/simple_tildagon.md") | 78.82 | 71.14 | 8.76 | 8.8 | 7.77 | 6.49   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [simulate.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/tildagon-apps/simulate.md "docs/tildagon-apps/simulate.md") | 76.27 | 65.32 | 8.35 | 9 | 8.69 | 6.71   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [badge-tent-volunteering.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/tildagon-firmware/badge-tent-volunteering.md "docs/tildagon-firmware/badge-tent-volunteering.md") | 74.86 | 74.9 | 8.34 | 8 | 9.21 | 7.87   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [accessory-ideas.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/using-the-badge/accessory-ideas.md "docs/using-the-badge/accessory-ideas.md") | 68.83 | 68.7 | 10.7 | 11.1 | 8.59 | 7.04   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [common-problems.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/using-the-badge/common-problems.md "docs/using-the-badge/common-problems.md") | 73.6 | 70.53 | 9.74 | 9.3 | 8.58 | 6.98   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [flash-the-badge.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/using-the-badge/flash-the-badge.md "docs/using-the-badge/flash-the-badge.md") | 77.8 | 66.13 | 7.86 | 8.3 | 9.04 | 6.7   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 [replacing-parts.md](https://github.com/emfcamp/badge-2024-documentation/blob/620b44f4a457737f3151235a75faad729bac5409/docs/using-the-badge/replacing-parts.md "docs/using-the-badge/replacing-parts.md") | 76.92 | 73.37 | 7.94 | 9.6 | 9.74 | 6.41   | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 Averages:   | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- Average | 71.22 | 61.5 | 8.95 | 9.82 | 9.86 | 6.88   | 🟢 +0.07 | 🟢 +0.02 | 🟢 +0 | 🟢 +0.02 | 🟢 +0.01 | 🟢 +0
View metric targets Metric | Range | Ideal score --- | --- | --- Flesch Reading Ease | 100 (very easy read) to 0 (extremely difficult read) | 60 Gunning Fog | 6 (very easy read) to 17 (extremely difficult read) | 8 or less Auto. Read. Index | 6 (very easy read) to 14 (extremely difficult read) | 8 or less Coleman Liau Index | 6 (very easy read) to 17 (extremely difficult read) | 8 or less Dale-Chall Readability | 4.9 (very easy read) to 9.9 (extremely difficult read) | 6.9 or less