codat-docs
codat-docs copied to clipboard
Update multiple-use-cases.md
Switched images to show correct process flow and added that clients must choose only one type of sync setting, not both
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.
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 | Jun 5, 2025 0:11am |
Overall readability score: 58.03 (🟢 +0)
| File | Readability |
|---|---|
| multiple-use-cases.md | 62.66 (🟢 +0.81) |
View detailed metrics
🟢 - Shows an increase in readability 🔴 - Shows a decrease in readability
| File | Readability | FRE | GF | ARI | CLI | DCRS |
|---|---|---|---|---|---|---|
| multiple-use-cases.md | 62.66 | 47.89 | 8.8 | 11.6 | 12.75 | 6.85 |
| 🟢 +0.81 | 🟢 +0.2 | 🟢 +0.11 | 🟢 +0.3 | 🟢 +0.06 | 🟢 +0.02 |
Averages:
| Readability | FRE | GF | ARI | CLI | DCRS | |
|---|---|---|---|---|---|---|
| Average | 58.03 | 48.71 | 10.35 | 11.55 | 12.07 | 7.83 |
| 🟢 +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 |