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

DOC-1090: Clean up some of the noisiest Vale errors and warnings #2457

Merged
merged 4 commits into from
Sep 10, 2024

Conversation

freakwriter
Copy link
Contributor

Tidied up some of the files with the noisiest Vale errors. Most changes are in the Embed Configuration page to remove excessive use of passive voice and add clarity to headers.

Copy link

netlify bot commented Sep 5, 2024

Deploy Preview for n8n-docs ready!

Name Link
🔨 Latest commit 7867d34
🔍 Latest deploy log https://app.netlify.com/sites/n8n-docs/deploys/66e0a6dfca74f10008137559
😎 Deploy Preview https://deploy-preview-2457--n8n-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

github-actions bot commented Sep 5, 2024

Overall readability score: 43.74 (🟢 +0)

File Readability
data-types.md 77.69 (🟢 +0.71)
introduction.md 44.93 (🔴 -3.49)
understand-agents.md 65.5 (🟢 +0)
understand-chains.md 66.72 (🟢 +0)
understand-memory.md 51.39 (🟢 +0)
understand-tools.md 71.93 (🟢 +0)
configuration.md 75.6 (🔴 -0.01)
contentful.md 58.29 (🔴 -1.03)
formstacktrigger.md 49.99 (🟢 +2.16)
xero.md 54.11 (🔴 -2.64)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
data-types.md 77.69 62.48 7.27 10.2 9.68 5.72
  🟢 +0.71 🟢 +0 🟢 +0 🟢 +0.1 🟢 +0.06 🟢 +0.15
introduction.md 44.93 28.09 8.23 14.9 16.9 8.34
  🔴 -3.49 🔴 -8.16 🟢 +0 🔴 -0.7 🔴 -0.57 🔴 -0.1
understand-agents.md 65.5 61.06 11.75 9.2 8.41 8.06
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
understand-chains.md 66.72 56.15 9.8 9.6 10.14 7.53
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
understand-memory.md 51.39 32.19 9.23 13 14.09 8.1
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
understand-tools.md 71.93 65.22 8.82 9.1 9.21 7.53
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
configuration.md 75.6 59.9 7.27 8.7 10.54 6.54
  🔴 -0.01 🟢 +0.1 🟢 +0.27 🔴 -0.1 🔴 -0.29 🟢 +0.02
contentful.md 58.29 35.74 7.52 12.9 14.42 6.95
  🔴 -1.03 🟢 +0.1 🔴 -0.01 🔴 -0.3 🔴 -0.35 🔴 -0.03
formstacktrigger.md 49.99 32.19 8.39 15.3 16.29 6.98
  🟢 +2.16 🟢 +1.52 🟢 +0.78 🟢 +0.4 🔴 -0.35 🟢 +0.15
xero.md 54.11 34.32 9.08 12.5 13.61 7.88
  🔴 -2.64 🔴 -7.95 🔴 -0.14 🔴 -0.3 🔴 -0.23 🔴 -0.1

Averages:

  Readability FRE GF ARI CLI DCRS
Average 43.74 35.16 11.54 14.8 14.31 8.49
  🟢 +0 🔴 -0.01 🟢 +0 🟢 +0 🟢 +0 🟢 +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

@freakwriter
Copy link
Contributor Author

@ayatnkw or @nik8n can one of you rubberstamp this PR? The Vale error logs were getting really noisy so this was a first quick pass at removing some of the most obnoxious errors. Nothing major changed content-wise other than replacing some written-out things with contractions and removing some heavy passive voice usage.

Copy link
Contributor

@ayatnkw ayatnkw left a comment

Choose a reason for hiding this comment

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

Looks good thank you!

@freakwriter freakwriter merged commit 08fa0dc into main Sep 10, 2024
7 checks passed
@freakwriter freakwriter deleted the DOC-1090 branch September 10, 2024 20:18
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