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

Create clipboard guide #1475 #1604

Merged
merged 4 commits into from
Oct 11, 2023
Merged

Conversation

vasfvitor
Copy link
Contributor

  • New or updated content

Description

The content is based on the README.md from the plugin's repo but I'm not sure about the use of assert, shouldn't be console.assert?

Still have to write the Rust part.

I'm looking at writing the other plugins guides, is it enough to adapt the content from each plugin's README.md*? I could just copy over and adapt. But my intention is to first try to use locally when possible.

* Most stubs give v2 plugin README as a reference to get started, and at least windows customization points to v1 docs.

Since I'm learning Tauri as I write these docs, I don't want to claim this current issue, for me there's no problem if someone else does.

@netlify
Copy link

netlify bot commented Oct 9, 2023

Deploy Preview for tauri-docs-starlight ready!

Name Link
🔨 Latest commit 934a2f9
🔍 Latest deploy log https://app.netlify.com/sites/tauri-docs-starlight/deploys/652662ca2af3dc0008d7b693
😎 Deploy Preview https://deploy-preview-1604--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.

@vasfvitor
Copy link
Contributor Author

vasfvitor commented Oct 9, 2023

The overall structure is based on the Notification plugin docs, and in there it has:

{/* TODO: Demo component */}

and

{/* TODO: Link to which language to use, frontend vs. backend guide when it's made */}

That I copied over this current guide, but I don't know what they refer to. Is the aim that each plugin have a guide and a demo component for every (not every) JS and Rust frameworks? Or just vanilla?

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 contribution @vasfvitor, thanks for putting this in! Just a few pieces of feedback and I think this one looks good to get merged in 💪

src/content/docs/features/clipboard.mdx Outdated Show resolved Hide resolved
src/content/docs/features/clipboard.mdx Show resolved Hide resolved
@vasfvitor vasfvitor marked this pull request as ready for review October 10, 2023 15:12
@lorenzolewis
Copy link
Member

Thanks @vasfvitor ! To answer your original questions:

I'm looking at writing the other plugins guides, is it enough to adapt the content from each plugin's README.md*? I could just copy over and adapt. But my intention is to first try to use locally when possible.

I think this is a really good start, and then note any gaps (like the Rust part you did here) so we can keep track of them. That does cause some duplication between the READMEs and what we have in the docs, but I don't think that's an issue as we start to treat the docs as the main source for references and documentation.

@lorenzolewis lorenzolewis merged commit bc35524 into tauri-apps:next Oct 11, 2023
@vasfvitor vasfvitor deleted the plugin-guides branch February 25, 2024 21:47
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