wails icon indicating copy to clipboard operation
wails copied to clipboard

Docs for Electron veterans with some Go experience

Open SheetJSDev opened this issue 3 years ago • 3 comments

Have you read the Documentation Contribution Guidelines?

Description

Electron and Wails have different philosophies. Many people are coming to Wails with experience in Electron development but not much Go experience. For some, it may even be their first foray!

Basic features provided by the Electron APIs, like filesystem operations, are not available in Wails. They require developers to dig into Go.

The documentation is currently written for an audience of Go veterans. It would be helpful to cover details for JS and Electron veterans who are not intimately familiar with Go.

.

For example, how do you download and save a file? You can fetch from JS, but actually writing to file requires knowing how to pass the data to the Go backend, how to show a Save File dialog, and how to write to the selected path.

This sort of "soft documentation" would touch upon a number of related problems like how to correctly marshal JS standard library types and how to structure Go routines. Go developers are familiar with standard modules like ioutil but the JS audience may not be as familiar.

Self-service

  • [X] I'd be willing to address this documentation request myself.

SheetJSDev avatar Aug 31 '22 19:08 SheetJSDev

Thanks for opening this! I don't have any electron experience so am really happy to accept PRs on this!

leaanthony avatar Aug 31 '22 21:08 leaanthony

请问一下,文档在哪 Excuse me, where is the document

lsm1103 avatar Sep 03 '22 03:09 lsm1103

image 关于这一块

lsm1103 avatar Sep 03 '22 03:09 lsm1103

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale[bot] avatar Nov 02 '22 02:11 stale[bot]

@SheetJSDev - did you still want to provide a PR for this?

leaanthony avatar Nov 02 '22 08:11 leaanthony