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: add documentation for plugins #1412

Merged
merged 26 commits into from Sep 7, 2023
Merged

feat: add documentation for plugins #1412

merged 26 commits into from Sep 7, 2023

Conversation

lucasfernog
Copy link
Member

No description provided.

@netlify
Copy link

netlify bot commented Aug 17, 2023

Deploy Preview for tauri-docs-starlight ready!

Name Link
🔨 Latest commit 0980f5a
🔍 Latest deploy log https://app.netlify.com/sites/tauri-docs-starlight/deploys/64f9f37563d2e80008bbd8f1
😎 Deploy Preview https://deploy-preview-1412--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

lorenzolewis commented Aug 17, 2023

Just going to capture a few notes to self here:

  • Some sections such as "lifecycle events" might belong in the references section instead, lets us elaborate on them without making the guide too heavy
  • Do android and iOS pages need to be separate guides? This is something we're talking about overall for the docs and how much we separate mobile concepts from desktop concepts. I'm in favour of keeping them as close as possible to minimise API and UX divergence between desktop and mobile.
  • Refer directly as Swift and Kotlin, not iOS and Android

Will do a more thorough review ASAP. Would love to use this as a solid reference to do a community/PR push to "develop and show us your Tauri 2.0 plugins" if/when we feel this is all stable enough.

Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com>
Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com>
Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com>
Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com>
Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com>
Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com>
Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com>
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.

Did some formatting on this one, need more input from dev to move further.

src/content/docs/2/guide/plugins/develop-plugin-ios.mdx Outdated Show resolved Hide resolved
src/content/docs/2/guide/plugins/develop-plugin.mdx Outdated Show resolved Hide resolved
src/content/docs/2/guide/plugins/index.mdx Outdated Show resolved Hide resolved
src/content/docs/2/guide/plugins/index.mdx Outdated Show resolved Hide resolved
src/content/docs/2/guide/plugins/index.mdx Outdated Show resolved Hide resolved
src/content/docs/2/guide/plugins/index.mdx Outdated Show resolved Hide resolved
src/content/docs/2/guide/plugins/index.mdx Outdated Show resolved Hide resolved
src/content/docs/2/guide/plugins/index.mdx Outdated Show resolved Hide resolved
src/content/docs/2/guide/plugins/index.mdx Outdated Show resolved Hide resolved
@lorenzolewis lorenzolewis added this to the Tauri Docs 2.0 milestone Sep 3, 2023
@lorenzolewis
Copy link
Member

I'll try to jump in on this one tomorrow and get the conflicts and structure cleaned up based on the updates and inputs from today. Thanks @lucasfernog 💜

@lorenzolewis
Copy link
Member

@lucasfernog I can see this chunk of documentation going in 1 of 2 ways:

  1. Keep it specific to mobile plugin development like we have now
  2. Use this as a baseline for building out a more extensive IPC guide for Swift and Kotlin/Java

The chunk on Commands I can see really fitting into a Commands/IPC guide and then we split that up a bit by language instead of platform. But I don't know how you want to position this feature and if it's in the spirit of a full-fledged IPC/binding for Swift and Kotlin/Java.

The JS IPC is really all handled by Tauri via invoke so it's a lot more accessible to end users. Whereas now (from what I understand) the Swift and Kotlin/Java IPC is really positioned more towards library/plugin authors. So it's your call on who you feel would be the proper target audience (specifically for the Commands sections). I can shift it into whichever direction based on that (right now it's in the direction of point 1 above).

@lucasfernog
Copy link
Member Author

The Kotlin/Swift IPC is only exposed for plugins, so IMO it doesn't make sense to move them out of the plugin documentation. Most application users will just want to leverage existing plugins instead of implementing custom logic for Android and iOS, and those who can do so, will need to write a plugin and go through all that documentation (and hopefully open source it to give back to the community ❤️ ).

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.

@lucasfernog wrapped up all the formatting and stuff for this one. I have one to-do that I'm going to take care for the CLI reference in the guide, but could you take a look at the other comments?

I think this one is good to go as soon as those are resolved 🥳

src/content/docs/2/guide/plugins/develop-mobile.mdx Outdated Show resolved Hide resolved
src/content/docs/2/guide/plugins/develop-mobile.mdx Outdated Show resolved Hide resolved
src/content/docs/2/guide/plugins/develop-mobile.mdx Outdated Show resolved Hide resolved
src/content/docs/2/guide/plugins/develop-mobile.mdx Outdated Show resolved Hide resolved
src/content/docs/2/guide/plugins/develop-mobile.mdx Outdated Show resolved Hide resolved
src/content/docs/2/guide/plugins/develop-mobile.mdx Outdated Show resolved Hide resolved
src/content/docs/2/guide/plugins/develop-mobile.mdx Outdated Show resolved Hide resolved
---

import Stub from '@components/Stub.astro';
{/* TODO: Add a CLI section */}
Copy link
Member

Choose a reason for hiding this comment

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

TODO for @lorenzolewis

src/content/docs/2/guide/plugins/index.mdx Outdated Show resolved Hide resolved
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.

Finally! (Siri, play Finally by CeCe Peniston)

Thanks @lucasfernog and @simonhyll

@lorenzolewis lorenzolewis merged commit 2d970c9 into next Sep 7, 2023
7 checks passed
@lorenzolewis lorenzolewis deleted the feat/plugins branch September 7, 2023 16:05
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

3 participants