ci: add documentation check on CI

[ematipico]

Summary

This PR does two things:

• adds the documentation check on the pull_request workflow and main workflow
• fixes warnings in the documentation

For now I added rome_formatter, rome_analyeze and rome_control_flow to the list of crates we want to document. Mostly because they are generic. Are there any other crates are worth documenting and push on github pages?

Test Plan

This PR should fail if there are warnings in the documentation.

[cloudflare-pages]

Deploying with    Cloudflare Pages

Latest commit:	eaa124c
Status:	✅  Deploy successful!
Preview URL:	https://ad461963.tools-8rn.pages.dev
Branch Preview URL:	https://feature-documentation-check.tools-8rn.pages.dev

View logs

[github-actions]

Playground for commit 34f69b3

[leops]

It might be useful to add rome_diagnostics to the crates documented on the website. Having rome_rowan and the rome_*_syntax / rome_*_factory could also make sense, to provide an easily searchable documentation for the Syntax API. Finally other library crates like rome_service, rome_console or rome_fs could be included, although these are a bit more "internal facing"

[ematipico]

This item was private, so I removed the link to not break its visibility. We can revisit it later

[ematipico]

analyze is function that lives in rome_js_analyze, so a link is not possible at the moment

[github-actions]

Parser conformance results on ubuntu-latest

js/262

Test result	main count	This PR count	Difference
Total	45878	45878	0
Passed	44938	44938	0
Failed	940	940	0
Panics	0	0	0
Coverage	97.95%	97.95%	0.00%

jsx/babel

Test result	main count	This PR count	Difference
Total	39	39	0
Passed	36	36	0
Failed	3	3	0
Panics	0	0	0
Coverage	92.31%	92.31%	0.00%

symbols/microsoft

Test result	main count	This PR count	Difference
Total	5946	5946	0
Passed	388	388	0
Failed	5558	5558	0
Panics	0	0	0
Coverage	6.53%	6.53%	0.00%

ts/babel

Test result	main count	This PR count	Difference
Total	588	588	0
Passed	519	519	0
Failed	69	69	0
Panics	0	0	0
Coverage	88.27%	88.27%	0.00%

ts/microsoft

Test result	main count	This PR count	Difference
Total	16257	16257	0
Passed	12393	12393	0
Failed	3864	3864	0
Panics	0	0	0
Coverage	76.23%	76.23%	0.00%

[xunilrj]

Do you think makes sense to upload the documentation together with the playground?

[ematipico]

Do you think makes sense to upload the documentation together with the playground?

Yes, although we should figure out first where to upload the documentation. The playground uses a mix of s3 and cloudflare. And unfortunately AWS is not correctly set up for everyone yet.