Skip to content

Proposal: Automate API Descriptions Update via GitHub Action #1937

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Bashamega opened this issue Mar 14, 2025 · 3 comments · Fixed by #1940
Closed

Proposal: Automate API Descriptions Update via GitHub Action #1937

Bashamega opened this issue Mar 14, 2025 · 3 comments · Fixed by #1940

Comments

@Bashamega
Copy link
Contributor

Bashamega commented Mar 14, 2025

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!

@saschanaz
Copy link
Contributor

Yeah, back in the days we had to fetch the full HTML, parse that to extract the phrases and convert it to markdown. Nowadays we have https://github.com/mdn/content directly in markdown so we can skip a lot of steps here. PR welcome.

@saschanaz
Copy link
Contributor

I think we should import MDN content directly rather than having apiDescriptions.json.

@Bashamega
Copy link
Contributor Author

I think we should import MDN content directly rather than having apiDescriptions.json.

Sure, I will do that

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 a pull request may close this issue.

2 participants