Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update aliases documentation with 'Brunch and learn' feedback #390

Merged
merged 6 commits into from
Nov 30, 2023

Conversation

jdbaldry
Copy link
Member

  • Update advice to say that you must add an alias when a page is move.
  • Update advice to say that you should add a comment explaining relative aliases.
  • Visually restructure examples for improved readability.

Signed-off-by: Jack Baldry [email protected]

- Update advice to say that you must add an alias when a page is move.
- Update advice to say that you should add a comment explaining relative aliases.
- Visually restructure examples for improved readability.

Signed-off-by: Jack Baldry <[email protected]>
Copy link
Contributor

github-actions bot commented Nov 28, 2023

Overall readability score: 60.72 (🟢 +0.01)

File Readability
index.md 68.44 (🟢 +0.4)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
index.md 68.44 48.7 8.81 9.8 10.84 6.74
  🟢 +0.4 🟢 +0.2 🔴 -0.2 🟢 +0.5 🟢 +0.4 🔴 -0.18

Averages:

  Readability FRE GF ARI CLI DCRS
Average 60.72 47.56 9.57 11.64 12.07 7.31
  🟢 +0.01 🟢 +0 🟢 +0 🟢 +0.01 🟢 +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

Signed-off-by: Jack Baldry <[email protected]>
docs/sources/write/front-matter/index.md Outdated Show resolved Hide resolved
docs/sources/write/front-matter/index.md Outdated Show resolved Hide resolved
docs/sources/write/front-matter/index.md Outdated Show resolved Hide resolved
docs/sources/write/front-matter/index.md Outdated Show resolved Hide resolved
docs/sources/write/front-matter/index.md Show resolved Hide resolved
docs/sources/write/front-matter/index.md Outdated Show resolved Hide resolved
Copy link
Member Author

@jdbaldry jdbaldry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking a look. This is a difficult topic and I appreciate you being willing to get into the weeds again.

docs/sources/write/front-matter/index.md Outdated Show resolved Hide resolved
docs/sources/write/front-matter/index.md Outdated Show resolved Hide resolved
docs/sources/write/front-matter/index.md Outdated Show resolved Hide resolved
docs/sources/write/front-matter/index.md Outdated Show resolved Hide resolved
…able for concrete redirects

Signed-off-by: Jack Baldry <[email protected]>
@jdbaldry jdbaldry force-pushed the jdb/2023-11-update-aliases-docs branch from 77e67df to 438c302 Compare November 29, 2023 18:44
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@jdbaldry jdbaldry merged commit af9264f into main Nov 30, 2023
6 checks passed
@jdbaldry jdbaldry deleted the jdb/2023-11-update-aliases-docs branch November 30, 2023 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants