n8n-docs icon indicating copy to clipboard operation
n8n-docs copied to clipboard

Squish allows

Open ayatnkw opened this issue 9 months ago • 3 comments

Changes

  • Rephrasing sentences using 'allows' and anthropomorphism.

Related tickets and issues

Doc-631

ayatnkw avatar May 03 '24 14:05 ayatnkw

Deploy Preview for n8n-docs ready!

Name Link
Latest commit e4d3629a1793b9ac4f10fe7533634fa85ce5c1ed
Latest deploy log https://app.netlify.com/sites/n8n-docs/deploys/663defca9fe8ad00084c32bc
Deploy Preview https://deploy-preview-2084--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.

netlify[bot] avatar May 03 '24 14:05 netlify[bot]

Overall readability score: 45.3 (🟢 +0.04)

File Readability
item-linking-code-node.md 78.74 (🟢 +0.05)
item-linking-node-creators.md 55.15 (🟢 +0.75)
subworkflow-usage.md 66.43 (🔴 -0.17)
cluster-nodes-summary.md 71.39 (🟢 +2.12)
code-node.md 64.57 (🔴 -0.02)
node-operations.md 65.37 (🟢 +1)
credential-only-intro.md 50.27 (🟢 +0.23)
api-workflow-tool.md 68.83 (🟢 +0.08)
data-google-sheets.md 70.48 (🟢 +0.25)
using-api-playground.md 61.34 (🟢 +0.08)
current-node-input.md 60.84 (🟢 +1.96)
output-other-nodes.md 56.7 (🟢 +10.07)
index.md 44.32 (🟢 +0)
pagination.md 79.28 (🔴 -0.57)
jmespath.md 33.28 (🟢 +0.31)
expressions.md 53.87 (🟢 +0.04)
index.md 72.13 (🟢 +0.16)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
item-linking-code-node.md 78.74 58.48 7.89 6.8 7.82 7.21
  🟢 +0.05 🔴 -0.41 🔴 -0.05 🟢 +0 🟢 +0.17 🔴 -0.01
item-linking-node-creators.md 55.15 45.86 10.18 12.4 12.47 8.11
  🟢 +0.75 🟢 +0.1 🟢 +0.02 🟢 +0.2 🟢 +0.11 🟢 +0.08
subworkflow-usage.md 66.43 55.34 9.02 11.4 11.37 6.64
  🔴 -0.17 🟢 +0.1 🔴 -0.12 🟢 +0.1 🟢 +0.05 🔴 -0.06
cluster-nodes-summary.md 71.39 60.65 8.65 10.1 9.28 7.07
  🟢 +2.12 🟢 +10.53 🔴 -0.41 🔴 -1 🟢 +1.55 🟢 +0.11
code-node.md 64.57 47.79 8.42 11.7 11.88 6.79
  🔴 -0.02 🟢 +0 🔴 -0.01 🟢 +0 🟢 +0 🟢 +0
node-operations.md 65.37 54.22 9.45 10.7 10.5 7.38
  🟢 +1 🟢 +0 🟢 +0 🟢 +0.2 🟢 +0.23 🟢 +0.12
credential-only-intro.md 50.27 45.66 10.84 12.8 13.05 8.83
  🟢 +0.23 🟢 +0.31 🟢 +0.05 🟢 +0.2 🟢 +0 🔴 -0.06
api-workflow-tool.md 68.83 56.25 8.89 9.3 9.45 7.8
  🟢 +0.08 🔴 -0.1 🔴 -0.02 🟢 +0 🟢 +0.05 🟢 +0.02
data-google-sheets.md 70.48 66.54 8.61 9.1 9.85 7.88
  🟢 +0.25 🔴 -0.1 🔴 -0.01 🟢 +0.1 🟢 +0.05 🟢 +0.02
using-api-playground.md 61.34 47.49 9.52 11.2 11.01 7.8
  🟢 +0.08 🟢 +0 🟢 +0 🟢 +0 🟢 +0.06 🟢 +0
current-node-input.md 60.84 46.98 8.05 14.7 12.18 6.62
  🟢 +1.96 🟢 +1.93 🟢 +0.62 🟢 +0.7 🔴 -0.29 🔴 -0.01
output-other-nodes.md 56.7 51.38 9.69 16.5 11.55 6.72
  🟢 +10.07 🟢 +6.5 🟢 +2.45 🟢 +2.9 🟢 +0 🟢 +0.18
index.md 44.32 37.3 10.72 14.7 13.11 9.43
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
pagination.md 79.28 60.82 6.98 7.7 9.26 6.61
  🔴 -0.57 🟢 +0.1 🔴 -0.1 🔴 -0.1 🔴 -0.17 🔴 -0.01
jmespath.md 33.28 30.6 12.36 20.8 16.48 7.41
  🟢 +0.31 🟢 +0 🟢 +0 🟢 +0.1 🟢 +0.12 🟢 +0
expressions.md 53.87 39.74 10.21 12.9 13.27 7.6
  🟢 +0.04 🟢 +0.11 🟢 +0.03 🟢 +0 🟢 +0 🔴 -0.01
index.md 72.13 66.03 7.81 9.5 10.14 7.46
  🟢 +0.16 🟢 +0.2 🟢 +0.06 🟢 +0 🟢 +0.06 🔴 -0.02

Averages:

  Readability FRE GF ARI CLI DCRS
Average 45.3 39.02 11.89 14.36 13.53 8.56
  🟢 +0.04 🟢 +0.05 🟢 +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

github-actions[bot] avatar May 03 '24 14:05 github-actions[bot]

I'm not sure if it's easier to review in smaller chunks or do it all in one go 🤔 @StarfallProjects

ayatnkw avatar May 03 '24 14:05 ayatnkw