-
Notifications
You must be signed in to change notification settings - Fork 667
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
feat: create JS and Rust dialog guide #1623
Conversation
✅ Deploy Preview for tauri-docs-starlight ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
Thanks for this! Overall really like the simplicity of this. For the headings could we use them to describe what the function is doing more clearly? For example: instead of "Ask" as a heading, we could instead have "Create Yes/No Dialog". This way the reader is able to quickly look at the TOC and jump to the desired result they'd like. |
Ok. Done |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome! Just a few adjustments. Would you like to take a stab at including Rust in this as well or would you like to leave that as a follow-up PR for you or someone else?
```js | ||
// Open a dialog | ||
const file = await open({ | ||
multiple: false, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of listing out each permutation of multiple
and directory
I think just adding a paragraph before the code block explaining what multiple
and directory
mean would be just as effective and reduce a lot of duplication.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think how you've done in the "Open" one is perfect by linking to the API references. This lets the reader understand the very basic functionality (which is what this page is for) and let's them jump off to customise and configure it from there (which is what the reference page is for).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I separated Rust and JavaScript guides into 2 blocks and moved stuff around. I hope that is ok. My reasoning is that this plugin have different ways to be used that does not translate into 1:1 blocks.
Also moved the link of Rust docs and JavaScript docs to the start of the block. Since it should be basic functionality I guess, content-wise, ready.
I'll write the Rust guide |
I'm good with splitting them out when it's not 1:1. I would just increase all of the headings under "Usage" by one so that the JS and Rust headings (and their specific children) sit nicely under "Usage". You could also add |
Done and done. Way better with the headings this way |
What kind of changes does this PR include?
Description
PartiallyAddresses Create Dialog guide #1477-
I'm still unsure what we should include or exclude from the guide. I mean, there are more options to each function that I didn't specify but it's written in the JS api docs.- This only includes JavaScript