Skip to content

Proposal: Automate API Descriptions Update via GitHub Action #1937

@Bashamega

Description

@Bashamega

Hello @saschanaz,

The inputfiles/mdn/apiDescriptions.json file is outdated and has not been maintained for the past five years. To ensure that we have up-to-date API descriptions, I propose implementing a weekly GitHub Action that:

  • Scrapes the relevant MDN documentation
  • Generates an updated JSON file
  • Automatically opens a pull request with the latest data

I have reviewed MDN’s [robots.txt](https://developer.mozilla.org/robots.txt) file, and it explicitly allows robots to scrape en-US/docs/Web/API, which covers the pages we need.

I would be happy to take on this task and contribute the necessary implementation.

Reference: #1909

Looking forward to your thoughts!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions