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

Using the API menu reorg #989

Merged
merged 4 commits into from
Feb 1, 2024
Merged

Using the API menu reorg #989

merged 4 commits into from
Feb 1, 2024

Conversation

pzaichkina
Copy link
Collaborator

@pzaichkina pzaichkina commented Jan 31, 2024

Description

Changes to the Using the API navigation structure

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)

Copy link

vercel bot commented Jan 31, 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 Feb 1, 2024 10:45am

@pzaichkina pzaichkina added the draft PR is in a draft state label Jan 31, 2024
Copy link

github-actions bot commented Jan 31, 2024

Overall readability score: 62.91 (🟢 +0)

File Readability
developers.md 100 (🟢 +0)
authentication.md 100 (🟢 +0)
client-side-data-storage.md 57.18 (🟢 +0)
implementing-a-mapping-page.md 56.11 (🟢 +0)
modified-dates.md 100 (🟢 +0)
optimizing-api-calls.md 76.16 (🟢 +0)
ordering-results.md 100 (🟢 +0)
View detailed metrics

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

File Readability FRE GF ARI CLI DCRS
developers.md 100 100 6 6 6 4.9
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
authentication.md 100 100 6 6 6 4.9
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
client-side-data-storage.md 57.18 51.99 12.26 11.5 10.85 7.8
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
implementing-a-mapping-page.md 56.11 45.76 11.11 12 12.29 7.57
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
modified-dates.md 100 100 6 6 6 4.9
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
optimizing-api-calls.md 76.16 63.59 8.93 8.2 8.41 6.83
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
ordering-results.md 100 100 6 6 6 4.9
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 62.91 53.15 9.75 10.82 11.41 7.48
  🟢 +0 🟢 +0 🟢 +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

@pzaichkina pzaichkina merged commit 2760934 into main Feb 1, 2024
3 checks passed
@pzaichkina pzaichkina deleted the api-sidebar-reorg branch February 1, 2024 11:09
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