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

feat: create OS Information guide #1484 #1642

Merged
merged 8 commits into from
Nov 6, 2023

Conversation

vasfvitor
Copy link
Contributor

@vasfvitor vasfvitor commented Oct 23, 2023

What kind of changes does this PR include?

  • New content

Description

I'm putting this out but I'm not sure what the Rust code, or even the JS should included, I mean, how much detail or step. Right now the Rust code is minimal, so is the JS, it's almost like the js-api reference. For comparison in the clipboard guide #1622, I've included three steps to use the Rust code, with the end goal of invoking in frontend.

edit: ok, I'm readin https://diataxis.fr/

@netlify
Copy link

netlify bot commented Oct 23, 2023

Deploy Preview for tauri-docs-starlight ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 343bed6
🔍 Latest deploy log https://app.netlify.com/sites/tauri-docs-starlight/deploys/65492d0ec2f53000080c153f
😎 Deploy Preview https://deploy-preview-1642--tauri-docs-starlight.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 100 (no change from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@lorenzolewis
Copy link
Member

To your point on this being a JS/Rust API reference I agree. I think that instead of listing out each different function, we could instead just have on function (such as platform) and then add a sentence saying additional functions as available with links to the API docs for each one.

@vasfvitor vasfvitor marked this pull request as ready for review November 6, 2023 01:52
@vasfvitor
Copy link
Contributor Author

Is that how you imagined?

Copy link
Member

@lorenzolewis lorenzolewis left a comment

Choose a reason for hiding this comment

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

Would just move this link to be further up at the top so the reader can more easily see it.

src/content/docs/features/os-info.mdx Outdated Show resolved Hide resolved
src/content/docs/features/os-info.mdx Outdated Show resolved Hide resolved
vasfvitor and others added 3 commits November 6, 2023 14:41
Copy link
Member

@lorenzolewis lorenzolewis left a comment

Choose a reason for hiding this comment

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

Awesome! And good catch with the docs.rs link

@lorenzolewis lorenzolewis merged commit 21f5e0e into tauri-apps:next Nov 6, 2023
5 checks passed
@vasfvitor vasfvitor deleted the os-guide branch February 25, 2024 21:50
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.

2 participants