feat: implement JSDoc-based documentation validation and automated MDX generation workflow - #197
Open
max-ostapenko wants to merge 6 commits into
Open
feat: implement JSDoc-based documentation validation and automated MDX generation workflow#197max-ostapenko wants to merge 6 commits into
max-ostapenko wants to merge 6 commits into
Conversation
…X generation workflow Signed-off-by: Max Ostapenko <1611259+max-ostapenko@users.noreply.github.com>
…c scripts Signed-off-by: Max Ostapenko <1611259+max-ostapenko@users.noreply.github.com>
…ric properties and nested object keys Signed-off-by: Max Ostapenko <1611259+max-ostapenko@users.noreply.github.com>
…tion generation, and update validation tool to traverse promise chains. Signed-off-by: Max Ostapenko <1611259+max-ostapenko@users.noreply.github.com>
…ilities for documentation validation Signed-off-by: Max Ostapenko <1611259+max-ostapenko@users.noreply.github.com>
…e compatibility validation Signed-off-by: Max Ostapenko <1611259+max-ostapenko@users.noreply.github.com>
https://almanac.httparchive.org/en/2022/Changed custom metrics values: {
"_ads": {
"ads": {
"present": false,
"status": 404,
"redirected": true
},
"app_ads": {
"present": false,
"status": 404,
"redirected": true
},
"sellers": {
"present": false,
"redirected": true,
"status": 404
}
},
"_privacy": {
"iab_tcf_v1": {
"present": false
},
"iab_tcf_v2": {
"present": false
},
"iab_gpp": {
"present": false
},
"iab_usp": {
"present": false
},
"navigator_doNotTrack": false,
"navigator_globalPrivacyControl": true,
"document_permissionsPolicy": false,
"document_featurePolicy": true,
"referrerPolicy": {
"entire_document_policy": null,
"individual_requests": null,
"link_relations": null
},
"request_hostnames_with_cname": {},
"ccpa_link": {
"hasCCPALink": false
},
"iab_ddr": {
"present": false,
"status": 404
}
}
} |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request introduces automated workflows and supporting scripts for validating and syncing JSDoc-based documentation with code. The primary focus is on ensuring documentation parity and providing a mechanism to generate and synchronize documentation with the
har.fyirepository.Example of the validated and generated docs: HTTPArchive/har.fyi#167
GitHub Actions Workflows:
.github/workflows/docs.ymlto validate JSDoc comments against code and automatically sync generated documentation to thehar.fyirepository via a pull request. This workflow runs on pushes, pull requests, and can be triggered manually..github/workflows/linter.ymlto include a newvalidate-docsjob that runs the documentation validation as part of the CI process.Documentation Scripts and Tooling:
validate:docsandgenerate:docsinpackage.jsonto run documentation validation and generation tools.