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.

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

Docs: Updated "Electron Accessing Files" to be more beginner friendly #16276

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

Sepehr0011
Copy link

@Sepehr0011 Sepehr0011 commented Aug 30, 2023

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Documentation
  • Code style update
  • Refactor
  • Build-related changes
  • Other, please describe:

Does this PR introduce a breaking change?

  • Yes
  • No

Other information:

as a beginner following the document to access files through Electron, it was very confusing and i would run into alot of errors because the document didn't have some steps that are required, those steps are in other part of the documentation namely "Frameless Electron Window" document which comes after this doc

so i just added those required steps in here :

Setting up @electron/remote window

installing @electron/remote and adding it to dependencies
setting it up in main.js and preload.js

the rest of the document is unchanged

as a beginner reading the document it was very confusing that i followed and did exactly what the document was telling me to do in order to achieve Reading and Writing Files through electron, but the document missed on some steps which are covered in "Frameless Electron Window" document

so i just added those parts in here
these are my changes :

### Setting up @electron/remote window
installing @electron/remote and adding it to dependencies
setting it up in main.js and preload.js
@Sepehr0011 Sepehr0011 changed the title Docs: Update Electron Accessing Files to be more beginner friendly Docs: Updated Electron Accessing Files to be more beginner friendly Aug 30, 2023
@Sepehr0011 Sepehr0011 changed the title Docs: Updated Electron Accessing Files to be more beginner friendly Docs: Updated "Electron Accessing Files" to be more beginner friendly Aug 30, 2023
@Sepehr0011
Copy link
Author

sorry for editing the title, im new to Pull Requests in general
and not really used to this

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 this pull request may close these issues.

None yet

1 participant