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: nativeImage api cleanup #41519

Merged
merged 5 commits into from Mar 12, 2024
Merged

docs: nativeImage api cleanup #41519

merged 5 commits into from Mar 12, 2024

Conversation

erickzhao
Copy link
Member

@erickzhao erickzhao commented Mar 6, 2024 •
edited

Description of Change

I was reading through the documentation and was a bit confused at times, so I wanted to take a stab at modernizing/cleaning it up.

  • Changes example from setting the Tray icon using Clipboard to just generating the NativeImage
  • Adds a preamble describing the utility of NativeImage (let me know if I'm off-base).
  • Adds additional links to Template Image and Data URL external docs.
  • A few wording changes to disambiguate concepts.

cc @electron/docs

Checklist

Release Notes

Notes: none

@electron-cation electron-cation bot added documentation 📓 semver/patch backwards-compatible bug fixes new-pr 🌱 PR opened in the last 24 hours labels Mar 6, 2024
@erickzhao erickzhao force-pushed the docs/native-image-api-cleanup branch from 4f27192 to b1ec5fa Compare March 6, 2024 01:23
dsanders11
dsanders11 reviewed Mar 6, 2024
View reviewed changes
docs/api/native-image.md Outdated Show resolved Hide resolved
@erickzhao erickzhao added target/29-x-y PR should also be added to the "29-x-y" branch. target/30-x-y PR should also be added to the "30-x-y" branch. labels Mar 6, 2024
felixrieseberg
felixrieseberg approved these changes Mar 7, 2024
View reviewed changes
Copy link
Member

@felixrieseberg felixrieseberg left a comment

Choose a reason for hiding this comment

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

Thank you!

@electron-cation electron-cation bot removed the new-pr 🌱 PR opened in the last 24 hours label Mar 7, 2024
@alicelovescake
Copy link
Contributor

Awesome changes to the docs! I like how you made everything more clear and specific!

erickzhao and others added 2 commits March 7, 2024 11:04
@erickzhao @felixrieseberg
Update docs/api/native-image.md
529e729 
Co-authored-by: Felix Rieseberg <fr@makenotion.com>
@erickzhao @alicelovescake
Update link to app icon
053200b 
Co-authored-by: Alice Zhao <66543449+alicelovescake@users.noreply.github.com>
@jkleinsc jkleinsc merged commit 2f133f5 into electron:main Mar 12, 2024
15 checks passed
@release-clerk Release Clerk
Copy link

release-clerk bot commented Mar 12, 2024

No Release Notes

@trop trop bot mentioned this pull request Mar 12, 2024
Merged
@trop
Copy link
Contributor

trop bot commented Mar 12, 2024

I have automatically backported this PR to "29-x-y", please check out #41569

@trop trop bot added in-flight/29-x-y and removed target/29-x-y PR should also be added to the "29-x-y" branch. labels Mar 12, 2024
@trop trop bot mentioned this pull request Mar 12, 2024
Merged
@trop
Copy link
Contributor

trop bot commented Mar 12, 2024

I have automatically backported this PR to "30-x-y", please check out #41570

@trop trop bot added in-flight/30-x-y and removed target/30-x-y PR should also be added to the "30-x-y" branch. labels Mar 12, 2024
@erickzhao erickzhao deleted the docs/native-image-api-cleanup branch March 12, 2024 17:10
@trop trop bot added merged/29-x-y PR was merged to the "29-x-y" branch. merged/30-x-y PR was merged to the "30-x-y" branch. and removed in-flight/29-x-y in-flight/30-x-y labels Mar 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dsanders11 dsanders11 dsanders11 approved these changes

@alicelovescake alicelovescake alicelovescake left review comments

@felixrieseberg felixrieseberg felixrieseberg approved these changes

@mlaurencin mlaurencin mlaurencin approved these changes

Assignees
No one assigned
Labels
documentation 📓 merged/29-x-y PR was merged to the "29-x-y" branch. merged/30-x-y PR was merged to the "30-x-y" branch. semver/patch backwards-compatible bug fixes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@erickzhao @alicelovescake @felixrieseberg @dsanders11 @mlaurencin @jkleinsc