Skip to content

API Descriptions Update - #1940

Merged
Jake Bailey (jakebailey) merged 97 commits into
microsoft:mainfrom
Bashamega:1937
Apr 17, 2025
Merged

API Descriptions Update#1940
Jake Bailey (jakebailey) merged 97 commits into
microsoft:mainfrom
Bashamega:1937

Conversation

@Bashamega

@Bashamega Adam Naji (Bashamega) commented Mar 15, 2025

Copy link
Copy Markdown
Contributor

fixes #1937

@github-actions

github-actions Bot commented Mar 15, 2025

Copy link
Copy Markdown
Contributor

Thanks for the PR!

This section of the codebase is owned by Kagami Sascha Rosylight (@saschanaz) - if they write a comment saying "LGTM" then it will be merged.

@saschanaz

Kagami Sascha Rosylight (saschanaz) commented Mar 15, 2025

Copy link
Copy Markdown
Contributor

We still depend on that, so we can't just remove it until we get a new mdn/content dependency?

@Bashamega

Adam Naji (Bashamega) commented Mar 15, 2025

Copy link
Copy Markdown
Contributor Author

We still depend on that, so we can't just remove it until we get a new mdn/content dependency?

I know

saschanaz
Kagami Sascha Rosylight (saschanaz) reviewed Mar 15, 2025
View reviewed changes
Comment thread src/build.ts Outdated
@Bashamega
feat: add mdn-content submodule for documentation resources
df3631e
@Bashamega
chore: revert
e9c9379
@Bashamega
feat: add script to recursively retrieve folder paths for API documen…
8e74526 
…tation
@Bashamega
feat: add generate script to build process for description generation
40e5317
@Bashamega
feat: enhance description generation by adding index.md content retri…
d7c6297 
…eval
@Bashamega
refactor: simplify folder retrieval logic in generateDescriptions.ts
51bc9cb
@Bashamega
feat: update output path for generated API descriptions JSON file
af54369
@Bashamega
-
1bb475e
@Bashamega
feat: add summary extraction from index.md content for description ge…
2695f20 
…neration
@Bashamega
feat: generate the API descriptions
5a5cbdd
@Bashamega
fix: json format
66f5156
@Bashamega
refactor: improve code readability and formatting in generateDescript…
61d4fde 
…ions.ts
@Bashamega
chore: generate baseline
c06f21b
@Bashamega
Adam Naji (Bashamega) marked this pull request as ready for review March 15, 2025 15:57
@Bashamega

Adam Naji (Bashamega) commented Mar 15, 2025

Copy link
Copy Markdown
Contributor Author

Hello Kagami Sascha Rosylight (@saschanaz),
I have created a script to generate the JSON, ran the baseline command, and fixed some linting problems, but I don't know how to solve the error you see in the logs. It is just one error.

@saschanaz

Kagami Sascha Rosylight (saschanaz) commented Mar 15, 2025

Copy link
Copy Markdown
Contributor

Maybe npm i?

@Bashamega

Adam Naji (Bashamega) commented Mar 16, 2025

Copy link
Copy Markdown
Contributor Author

Maybe npm i?

Hello:)
How will npm i help?
I ran it and it didn't do anything

@saschanaz

Kagami Sascha Rosylight (saschanaz) commented Mar 16, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

I mean npm i && npm run build && npm run baseline-accept? Because it seems like it's caused by mismatch of installed dependency version. npm i fixes that.

@Bashamega

Adam Naji (Bashamega) commented Mar 16, 2025

Copy link
Copy Markdown
Contributor Author

I mean npm i && npm run build && npm run baseline-accept? Because it seems like it's caused by mismatch of dependency version. npm i fixes that.
oh okay

saschanaz
Kagami Sascha Rosylight (saschanaz) reviewed Mar 16, 2025
View reviewed changes
Comment thread baselines/audioworklet.generated.d.ts Outdated
jakebailey
Jake Bailey (jakebailey) reviewed Apr 15, 2025
View reviewed changes
Comment thread src/build/mdn-comments.ts
jakebailey
Jake Bailey (jakebailey) reviewed Apr 15, 2025
View reviewed changes
Comment thread .github/workflows/update-core-deps.yml
jakebailey
Jake Bailey (jakebailey) approved these changes Apr 15, 2025
View reviewed changes

@jakebailey Jake Bailey (jakebailey) left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Theoretically seems good to me; Kagami Sascha Rosylight (@saschanaz) seem alright as a first go?

@Bashamega Adam Naji (Bashamega) mentioned this pull request Apr 16, 2025
Closed
@Bashamega

Adam Naji (Bashamega) commented Apr 17, 2025

Copy link
Copy Markdown
Contributor Author

Hi Kagami Sascha Rosylight (@saschanaz), Jake Bailey (@jakebailey), Nathan Shively-Sanders (@sandersn) 👋

I've looked into ways to clone only specific parts of a repo without fetching the entire repository. Git doesn't support this natively, but I found a practical workaround using SVN (Subversion).

Although it's an older tool, it’s still supported by GitHub and allows downloading a single directory without pulling the whole repo. This might be a viable solution for our case—just wanted to share as a proposal for consideration.

@jakebailey

Jake Bailey (jakebailey) commented Apr 17, 2025

Copy link
Copy Markdown
Member

I don't think we need to do anything fancy. The submodule is fine.

@Bashamega

Adam Naji (Bashamega) commented Apr 17, 2025

Copy link
Copy Markdown
Contributor Author

I don't think we need to do anything fancy. The submodule is fine.

Okay, do you have any estimation of when this pr will be merged?

@saschanaz

Kagami Sascha Rosylight (saschanaz) commented Apr 17, 2025

Copy link
Copy Markdown
Contributor

SVN is not supported by GitHub https://github.blog/news-insights/product-news/sunsetting-subversion-support/ (I'm pretty surprised that it was supported at all)

@saschanaz

Kagami Sascha Rosylight (saschanaz) commented Apr 17, 2025

Copy link
Copy Markdown
Contributor

I see no blocker to not merge.

@Bashamega

Adam Naji (Bashamega) commented Apr 17, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

SVN is not supported by GitHub https://github.blog/news-insights/product-news/sunsetting-subversion-support/ (I'm pretty surprised that it was supported at all)

Good to know, I didn't know

I see no blocker to not merge.

Me too. Can you merge it?

@saschanaz

Kagami Sascha Rosylight (saschanaz) commented Apr 17, 2025

Copy link
Copy Markdown
Contributor

I mean only if I could... 🤷🏻‍♀️

LGTM

@github-actions

github-actions Bot commented Apr 17, 2025

Copy link
Copy Markdown
Contributor

Sorry Kagami Sascha Rosylight (@saschanaz), you don't have access to these files:

@Bashamega

Adam Naji (Bashamega) commented Apr 17, 2025

Copy link
Copy Markdown
Contributor Author

Hello Jake Bailey (@jakebailey)
Sorry for pinging you, but I think this PR is ready to be merged

@jakebailey

Jake Bailey (jakebailey) commented Apr 17, 2025

Copy link
Copy Markdown
Member

I'll merge it now, I had just replied late at night 😄

@jakebailey
Jake Bailey (jakebailey) merged commit 7b677e2 into microsoft:main Apr 17, 2025
@Bashamega

Adam Naji (Bashamega) commented Apr 17, 2025

Copy link
Copy Markdown
Contributor Author

I'll merge it now, I had just replied late at night 😄

Thank you very much for merging this huge PR. You just made my day :)

This was referenced Apr 23, 2025
Merged
Closed
@harryhjsh harryhjsh (harryhjsh) mentioned this pull request Nov 20, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jakebailey Jake Bailey (jakebailey) jakebailey approved these changes
@sandersn Nathan Shively-Sanders (sandersn) Awaiting requested review from sandersn
@saschanaz Kagami Sascha Rosylight (saschanaz) Awaiting requested review from saschanaz

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Proposal: Automate API Descriptions Update via GitHub Action

5 participants

@Bashamega @saschanaz @jakebailey @sandersn @github-advanced-security