issues
search
emfcamp
/
badge-2024-documentation
Tildagon badge documentation website
https://tildagon.badge.emfcamp.org/
21
stars
38
forks
source link
Create markdown-lint.yml
#201
Closed
npentrel
closed
5 months ago
github-actions[bot]
commented
5 months ago
Overall readability score:
71.94 (🟢 +0.72)
File
Readability
creating-hexpansions.md
71.46 (🟢 +0)
index.md
61.28 (🟢 +7.49)
bitmaps.md
54.69 (🟢 +0)
index.md
65.71 (🟢 +8.36)
publish.md
65.93 (🟢 +4.72)
simple_tildagon.md
78.82 (🟢 +0)
simulate.md
76.27 (🟢 +0)
badge-tent-volunteering.md
74.86 (🟢 +0)
index.md
7.9 (🟢 +1.03)
connect-to-wifi.md
74.39 (🟢 +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/6b0d2f4ac30ae84de2e868d77b755cab14a0abcd/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 [index.md](https://github.com/emfcamp/badge-2024-documentation/blob/6b0d2f4ac30ae84de2e868d77b755cab14a0abcd/docs/index.md "docs/index.md") | 61.28 | 53.81 | 11.12 | 11.5 | 10.73 | 7.28 | 🟢 +7.49 | 🟢 +8.66 | 🟢 +0.08 | 🟢 +2.2 | 🟢 +1.91 | 🟢 +0.01 [bitmaps.md](https://github.com/emfcamp/badge-2024-documentation/blob/6b0d2f4ac30ae84de2e868d77b755cab14a0abcd/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 [index.md](https://github.com/emfcamp/badge-2024-documentation/blob/6b0d2f4ac30ae84de2e868d77b755cab14a0abcd/docs/tildagon-apps/index.md "docs/tildagon-apps/index.md") | 65.71 | 56.66 | 10.73 | 9.4 | 10.08 | 7.49 | 🟢 +8.36 | 🟢 +8.67 | 🟢 +0 | 🟢 +2.3 | 🟢 +2.09 | 🟢 +0.2 [publish.md](https://github.com/emfcamp/badge-2024-documentation/blob/6b0d2f4ac30ae84de2e868d77b755cab14a0abcd/docs/tildagon-apps/publish.md "docs/tildagon-apps/publish.md") | 65.93 | 53.81 | 9.61 | 11.2 | 10.03 | 7.08 | 🟢 +4.72 | 🟢 +0.1 | 🟢 +0.2 | 🟢 +1.4 | 🟢 +1.22 | 🟢 +0.19 [simple_tildagon.md](https://github.com/emfcamp/badge-2024-documentation/blob/6b0d2f4ac30ae84de2e868d77b755cab14a0abcd/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/6b0d2f4ac30ae84de2e868d77b755cab14a0abcd/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/6b0d2f4ac30ae84de2e868d77b755cab14a0abcd/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 [index.md](https://github.com/emfcamp/badge-2024-documentation/blob/6b0d2f4ac30ae84de2e868d77b755cab14a0abcd/docs/tildagon-firmware/index.md "docs/tildagon-firmware/index.md") | 7.9 | 0 | 17.58 | 22 | 19 | 9.3 | 🟢 +1.03 | 🟢 +0 | 🟢 +0.28 | 🟢 +0 | 🟢 +0 | 🟢 +0.17 [connect-to-wifi.md](https://github.com/emfcamp/badge-2024-documentation/blob/6b0d2f4ac30ae84de2e868d77b755cab14a0abcd/docs/using-the-badge/connect-to-wifi.md "docs/using-the-badge/connect-to-wifi.md") | 74.39 | 65.73 | 8.28 | 9.6 | 9.97 | 6.52 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 Averages: | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- Average | 71.94 | 62.08 | 8.93 | 9.62 | 9.69 | 6.86 | 🟢 +0.72 | 🟢 +0.58 | 🟢 +0.02 | 🟢 +0.2 | 🟢 +0.17 | 🟢 +0.02
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
Overall readability score: 71.94 (🟢 +0.72)
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/6b0d2f4ac30ae84de2e868d77b755cab14a0abcd/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 [index.md](https://github.com/emfcamp/badge-2024-documentation/blob/6b0d2f4ac30ae84de2e868d77b755cab14a0abcd/docs/index.md "docs/index.md") | 61.28 | 53.81 | 11.12 | 11.5 | 10.73 | 7.28 | 🟢 +7.49 | 🟢 +8.66 | 🟢 +0.08 | 🟢 +2.2 | 🟢 +1.91 | 🟢 +0.01 [bitmaps.md](https://github.com/emfcamp/badge-2024-documentation/blob/6b0d2f4ac30ae84de2e868d77b755cab14a0abcd/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 [index.md](https://github.com/emfcamp/badge-2024-documentation/blob/6b0d2f4ac30ae84de2e868d77b755cab14a0abcd/docs/tildagon-apps/index.md "docs/tildagon-apps/index.md") | 65.71 | 56.66 | 10.73 | 9.4 | 10.08 | 7.49 | 🟢 +8.36 | 🟢 +8.67 | 🟢 +0 | 🟢 +2.3 | 🟢 +2.09 | 🟢 +0.2 [publish.md](https://github.com/emfcamp/badge-2024-documentation/blob/6b0d2f4ac30ae84de2e868d77b755cab14a0abcd/docs/tildagon-apps/publish.md "docs/tildagon-apps/publish.md") | 65.93 | 53.81 | 9.61 | 11.2 | 10.03 | 7.08 | 🟢 +4.72 | 🟢 +0.1 | 🟢 +0.2 | 🟢 +1.4 | 🟢 +1.22 | 🟢 +0.19 [simple_tildagon.md](https://github.com/emfcamp/badge-2024-documentation/blob/6b0d2f4ac30ae84de2e868d77b755cab14a0abcd/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/6b0d2f4ac30ae84de2e868d77b755cab14a0abcd/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/6b0d2f4ac30ae84de2e868d77b755cab14a0abcd/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 [index.md](https://github.com/emfcamp/badge-2024-documentation/blob/6b0d2f4ac30ae84de2e868d77b755cab14a0abcd/docs/tildagon-firmware/index.md "docs/tildagon-firmware/index.md") | 7.9 | 0 | 17.58 | 22 | 19 | 9.3 | 🟢 +1.03 | 🟢 +0 | 🟢 +0.28 | 🟢 +0 | 🟢 +0 | 🟢 +0.17 [connect-to-wifi.md](https://github.com/emfcamp/badge-2024-documentation/blob/6b0d2f4ac30ae84de2e868d77b755cab14a0abcd/docs/using-the-badge/connect-to-wifi.md "docs/using-the-badge/connect-to-wifi.md") | 74.39 | 65.73 | 8.28 | 9.6 | 9.97 | 6.52 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 | 🟢 +0 Averages: | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- Average | 71.94 | 62.08 | 8.93 | 9.62 | 9.69 | 6.86 | 🟢 +0.72 | 🟢 +0.58 | 🟢 +0.02 | 🟢 +0.2 | 🟢 +0.17 | 🟢 +0.02View 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