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

docs: clean up the native modules documentation #26813

Merged
merged 1 commit into from
Dec 8, 2020
Merged

docs: clean up the native modules documentation #26813

merged 1 commit into from
Dec 8, 2020

Conversation

malept
Copy link
Member

@malept malept commented Dec 3, 2020

Description of Change

Attempt to make the native modules documentation clearer, and mention Electron Forge where appropriate.

CC: @electron/wg-ecosystem

Checklist

Release Notes

Notes: no-notes

@electron-cation electron-cation bot added the new-pr 🌱 PR opened in the last 24 hours label Dec 3, 2020
@malept malept requested a review from a team December 3, 2020 06:50
erickzhao
erickzhao reviewed Dec 3, 2020
View reviewed changes
Copy link
Member

@erickzhao erickzhao left a comment

Choose a reason for hiding this comment

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

We should probably also add mentions to the work done in #18397.

Also question: does all this still apply to rebuilding modules written with N-API?

@MarshallOfSound
Copy link
Member

Also question: does all this still apply to rebuilding modules written with N-API?

Yes

@malept
Copy link
Member Author

malept commented Dec 4, 2020

We should probably also add mentions to the work done in #18397.

Can this be done in a follow-up PR? That seems like a big chunk of work to adapt that issue summary into docs.

Semver Label Enforcement In progress — No semver/ label found*

@MarshallOfSound can this check be skipped for pure docs changes?

@erickzhao
Copy link
Member

Can this be done in a follow-up PR?

Sounds good to me.

@MarshallOfSound
Copy link
Member

@MarshallOfSound can this check be skipped for pure docs changes?

It's not skipped for any changes, adding a semver/patch label isn't too tricky 😄

@MarshallOfSound MarshallOfSound added the semver/patch backwards-compatible bug fixes label Dec 7, 2020
@electron-cation electron-cation bot removed the new-pr 🌱 PR opened in the last 24 hours label Dec 7, 2020
@zcbenz zcbenz merged commit 3bc220d into electron:master Dec 8, 2020
@release-clerk
Copy link

release-clerk bot commented Dec 8, 2020

No Release Notes

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

@erickzhao erickzhao erickzhao left review comments

@zcbenz zcbenz zcbenz approved these changes

Assignees
No one assigned
Labels
documentation 📓 semver/patch backwards-compatible bug fixes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@malept @MarshallOfSound @erickzhao @zcbenz