codatio / codat-docs

Build powerful applications with financial data
https://docs.codat.io/
Apache License 2.0
18 stars 35 forks source link

Clearer roles info #1357

Closed mcclowes closed 1 week ago

mcclowes commented 1 week ago

Description

Type of change

Please delete options that are not relevant.

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.

vercel[bot] commented 1 week ago

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

Name Status Preview Comments Updated (UTC)
codat-docs 🔄 Building (Inspect) Visit Preview 💬 Add feedback Sep 26, 2024 4:16pm
github-actions[bot] commented 1 week ago

Overall readability score: 60.31 (🟢 +0.08)

File Readability
230217-uat-deprecation-dns.md 47.82 (🟢 +6.5)
user-roles.md 61.04 (🟢 +2.2)
View detailed metrics 🟢 - Shows an _increase_ in readability 🔴 - Shows a _decrease_ in readability File | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- [230217-uat-deprecation-dns.md](https://github.com/codatio/codat-docs/blob/31513a184cf59c80379ca6021ecebf7c73f86202/blog/230217-uat-deprecation-dns.md "blog/230217-uat-deprecation-dns.md") | 47.82 | 42.92 | 13.66 | 13.3 | 12.53 | 7.95   | 🟢 +6.5 | 🟢 +2.95 | 🟢 +1.3 | 🟢 +1.6 | 🟢 +0.53 | 🟢 +0.22 [user-roles.md](https://github.com/codatio/codat-docs/blob/31513a184cf59c80379ca6021ecebf7c73f86202/docs/configure/user-management/user-roles.md "docs/configure/user-management/user-roles.md") | 61.04 | 40.04 | 9.3 | 10.7 | 12 | 7.42   | 🟢 +2.2 | 🟢 +1.62 | 🟢 +0.74 | 🟢 +0.5 | 🟢 +0 | 🔴 -0.02 Averages:   | Readability | FRE | GF | ARI | CLI | DCRS --- | --- | --- | --- | --- | --- | --- Average | 60.31 | 51.01 | 10.07 | 11.16 | 11.73 | 7.71   | 🟢 +0.08 | 🟢 +0.09 | 🟢 +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
github-actions[bot] commented 1 week ago

Link check results (filtered):

[
  "[404] https://docs.codat.io/updates/platform-api",
  "[404] https://docs.codat.io/404"
]