Skip to content
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.

Sign up for GitHub

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

Jump to bottom

API Descriptions Update #1940

Open
wants to merge 83 commits into
base: main
Choose a base branch
from
Open

API Descriptions Update #1940

wants to merge 83 commits into from

Conversation

Bashamega
Copy link
Contributor

fixes #1937

@github-actions GitHub Actions
Copy link
Contributor

Thanks for the PR!

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

@saschanaz
Copy link
Contributor

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

@Bashamega
Copy link
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
saschanaz reviewed Mar 15, 2025
View reviewed changes
Bashamega added 13 commits March 15, 2025 13:40
@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 Bashamega marked this pull request as ready for review March 15, 2025 15:57
@Bashamega
Copy link
Contributor Author

Hello @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
Copy link
Contributor

Maybe npm i?

@Bashamega
Copy link
Contributor Author

Maybe npm i?

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

@saschanaz
Copy link
Contributor

saschanaz commented Mar 16, 2025 •
edited
Loading

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
Copy link
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

@Bashamega Bashamega requested a review from saschanaz March 16, 2025 09:50
@Bashamega
Copy link
Contributor Author

I have fixed all the issues @saschanaz

@Bashamega Bashamega requested a review from saschanaz March 31, 2025 11:18
This was referenced Apr 1, 2025
Closed
Closed
Closed
@saschanaz saschanaz mentioned this pull request Apr 1, 2025
Closed
saschanaz
saschanaz reviewed Apr 1, 2025
View reviewed changes
Copy link
Contributor

@saschanaz saschanaz left a comment

Choose a reason for hiding this comment

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

Almost there!

@Bashamega
Copy link
Contributor Author

Done @saschanaz

saschanaz
saschanaz reviewed Apr 2, 2025
View reviewed changes
Copy link
Contributor

@saschanaz saschanaz left a comment

Choose a reason for hiding this comment

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

The only blocking change is the workflow thing, otherwise this looks mostly fine. 🎉

@Bashamega
Copy link
Contributor Author

Done @saschanaz

saschanaz
saschanaz reviewed Apr 2, 2025
View reviewed changes
@Bashamega
Copy link
Contributor Author

Done @saschanaz

@Bashamega
Copy link
Contributor Author

Hello @saschanaz,

My PR to the MDN repo has been merged, and I’ve synced the repo to resolve the abbreviation issue.

@saschanaz
Copy link
Contributor

LGTM, thanks! (This may also require Microsoft review, but let me try given there's no maintainers tag...)

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 3, 2025

Sorry @saschanaz, you don't have access to these files:

@saschanaz
Copy link
Contributor

^ @sandersn, can you take a look?

@Bashamega
Copy link
Contributor Author

Hello @sandersn
Can you please check this PR and merge it?
Thank you
CC - @saschanaz

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

@saschanaz saschanaz saschanaz left review comments

At least 1 approving review is required to merge this pull request.

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
2 participants
@Bashamega @saschanaz