Skip to content

feat: implement JSDoc-based documentation validation and automated MDX generation workflow - #197

Open
max-ostapenko wants to merge 6 commits into
mainfrom
yappy-peacock
Open

feat: implement JSDoc-based documentation validation and automated MDX generation workflow#197
max-ostapenko wants to merge 6 commits into
mainfrom
yappy-peacock

Conversation

@max-ostapenko

@max-ostapenko max-ostapenko commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

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.fyi repository.

Example of the validated and generated docs: HTTPArchive/har.fyi#167

GitHub Actions Workflows:

  • Added a new workflow .github/workflows/docs.yml to validate JSDoc comments against code and automatically sync generated documentation to the har.fyi repository via a pull request. This workflow runs on pushes, pull requests, and can be triggered manually.
  • Updated .github/workflows/linter.yml to include a new validate-docs job that runs the documentation validation as part of the CI process.

Documentation Scripts and Tooling:

  • Added new npm scripts validate:docs and generate:docs in package.json to run documentation validation and generation tools.

…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>
@github-actions

Copy link
Copy Markdown
https://almanac.httparchive.org/en/2022/

WPT result details

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
    }
  }
}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant