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

Improved write back docs #1428

Merged
merged 12 commits into from
Nov 18, 2024
Merged

Improved write back docs #1428

merged 12 commits into from
Nov 18, 2024

Conversation

dcoplowe
Copy link
Collaborator

@dcoplowe dcoplowe commented Nov 6, 2024

Description

  • Include a summary of the new content you're adding or the reason for the change.
  • Include relevant context.
  • Do not link to work items.
  • Any PNG images should be compressed using Tiny PNG or equivalent.

Type of change

Please delete options that are not relevant.

  • New document(s)/updating existing
  • Fixes
  • Styling
  • Bug fix (non-breaking change which fixes an issue)

Reviews and merging

You are responsible for getting your PR merged. Address review comments promptly and make sure to merge the PR when ready.
Feel free to 'Enable automerge' - your PR will automatically merge when accepted and passing the build.

Copy link

vercel bot commented Nov 6, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
codat-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 18, 2024 10:15am

Copy link

github-actions bot commented Nov 6, 2024

Overall readability score: 59.29 (🔴 -0.05)

File Readability
create-account.md 50.31 (🟢 +0)
introduction.md 42.31 (🟢 +0)
configure.md 61.69 (🔴 -5.32)
deposit.md 43.68 (🔴 -10.67)
introduction.md 51.95 (🔴 -2.1)
record-general-loan.md 67.11 (🟢 +0)
overview.md 16.46 (🟢 +0)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
create-account.md 50.31 43.73 10.76 13.6 13.23 8.32
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
introduction.md 42.31 42.41 14.05 13.9 13.05 8.93
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
configure.md 61.69 49.31 7.62 11.2 13.27 7.81
  🔴 -5.32 🔴 -9.68 🟢 +0.54 🔴 -1.4 🔴 -1.51 🔴 -0.15
deposit.md 43.68 45.93 15.16 9.1 12.37 10.56
  🔴 -10.67 🟢 +0.21 🔴 -3.99 🔴 -0.1 🔴 -0.29 🔴 -1.03
introduction.md 51.95 46.27 12.05 11.9 12.64 8.28
  🔴 -2.1 🔴 -5.72 🟢 +1.05 🔴 -0.2 🔴 -1.73 🔴 -0.07
record-general-loan.md 67.11 55.4 8.33 8.2 10.63 8.57
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
overview.md 16.46 0 12.49 22 19 9.35
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 59.29 49.93 10.19 11.32 11.89 7.77
  🔴 -0.05 🔴 -0.05 🔴 -0.01 🔴 -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

Copy link

Link check results (filtered):

[]

@dcoplowe dcoplowe merged commit 852cc1f into main Nov 18, 2024
3 of 4 checks passed
@dcoplowe dcoplowe deleted the loan-writeback-improvements branch November 18, 2024 10:13
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