chore: add a docs report actions for PRs

[binoy14]

Description

This PR adds github actions flow that runs a docs coverage report on every PR and current. On the PR it creates a new dataset and compares the changes in documentation coverage between current and this PR to make sure overtime we are not decreasing the coverage.

What to review

The logic makes sense.

Notes for release

N/A (internal)

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
performance-studio	✅ Ready (Inspect)	Visit Preview		Sep 6, 2023 1:11pm
test-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Sep 6, 2023 1:11pm

1 Ignored Deployment

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview		Sep 6, 2023 1:11pm

[github-actions]

Component Testing Report Updated Sep 6, 2023 1:13 PM (UTC)

File	Status	Duration	Passed	Skipped	Failed
formBuilder/ArrayInput.spec.tsx	✅ Passed (Inspect)	9s	3	0	0
formBuilder/inputs/PortableText/Annotations.spec.tsx	✅ Passed (Inspect)	11s	3	0	0
formBuilder/inputs/PortableText/Decorators.spec.tsx	✅ Passed (Inspect)	9s	6	0	0
formBuilder/inputs/PortableText/Input.spec.tsx	✅ Passed (Inspect)	12s	9	0	0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	✅ Passed (Inspect)	44s	18	0	0
formBuilder/inputs/PortableText/Styles.spec.tsx	✅ Passed (Inspect)	10s	6	0	0
formBuilder/inputs/PortableText/Toolbar.spec.tsx	✅ Passed (Inspect)	5s	3	0	0

[github-actions]

Package	Documentation Change
@sanity/portable-text-editor	+5%
@sanity/types	+2%
sanity	-1%
sanity/desk	-3%

Full Report

@sanity/portable-text-editor

This branch	Current release
21 documented	20 documented
44 not documented	44 not documented

@sanity/types

This branch	Current release
46 documented	45 documented
240 not documented	240 not documented

@sanity/diff

This branch	Current release
13 documented	13 documented
16 not documented	0 not documented

@sanity/block-tools

This branch	Current release
4 documented	4 documented
9 not documented	9 not documented

@sanity/mutator

This branch	Current release
7 documented	7 documented
4 not documented	4 not documented

@sanity/cli

This branch	Current release
1 documented	1 documented
30 not documented	30 not documented

@sanity/schema/_internal

This branch	Current release
0 documented	0 documented
9 not documented	8 not documented

@sanity/util/paths

This branch	Current release
1 documented	1 documented
15 not documented	15 not documented

sanity/router

This branch	Current release
15 documented	15 documented
21 not documented	21 not documented

@sanity/util/legacyDateFormat

This branch	Current release
0 documented	0 documented
3 not documented	3 not documented

@sanity/schema

This branch	Current release
0 documented	0 documented
2 not documented	2 not documented

sanity/cli

This branch	Current release
2 documented	2 documented
0 not documented	0 not documented

@sanity/vision

This branch	Current release
0 documented	0 documented
2 not documented	2 not documented

@sanity/util/fs

This branch	Current release
0 documented	0 documented
3 not documented	3 not documented

sanity/_internal

This branch	Current release
0 documented	0 documented
1 not documented	1 not documented

@sanity/util/content

This branch	Current release
1 documented	1 documented
5 not documented	4 not documented

sanity

This branch	Current release
109 documented	110 documented
835 not documented	856 not documented

sanity/desk

This branch	Current release
83 documented	85 documented
54 not documented	54 not documented

[skogsmaskin]

This is great!