You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Aug 31, 2023. It is now read-only.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
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"
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.
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Labels
None yet
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR does two things:
pull_request
workflow andmain
workflowFor now I added
rome_formatter
,rome_analyeze
androme_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.