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

docs/Add new Integrations section + Tauri guide #2142

Merged

Conversation

SebasF1349
Copy link
Member

Description

Added new integrations section and a guide to integrate Skeleton with Tauri.

This is mostly done, but I still want to add a template for people to use so it's not ready to merge. As it's not complete, changeset hasn't been added yet.

Changsets

Instructions: Changesets automate our changelog. If you modify files in /packages/skeleton, run pnpm changeset in the root of the monorepo, follow the prompts, then commit the markdown file. Changes that add features should be minor while chores and bugfixes should be patch. Please prefix the changeset message with feat:, bugfix: or chore:.

Checklist

Please read and apply all contribution requirements.

  • This PR targets the dev branch (NEVER master)
  • Documentation reflects all relevant changes
  • Branch is prefixed with: docs/, feat/, chore/, bugfix/
  • Ensure Svelte and Typescript linting is current - run pnpm check
  • Ensure Prettier linting is current - run pnpm format
  • All test cases are passing - run pnpm test
  • Includes a changeset (if relevant; see above)

@changeset-bot
Copy link

changeset-bot bot commented Oct 13, 2023

⚠️ No Changeset found

Latest commit: ab90d11

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Oct 13, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
skeleton-docs ✅ Ready (Inspect) Visit Preview Oct 24, 2023 5:11pm

@niktek
Copy link
Contributor

niktek commented Oct 13, 2023

Just a suggestion, but maybe to show the logical flow a bit more clearly, have the headers like:

  • Create your Skeleton project
  • Modify your Skeleton project for Tauri
  • Add the Tauri backend

I can see people sort of clicking on the https://tauri.app/v1/guides/getting-started/setup/sveltekit#sveltekit-in-ssg-mode and doing a top down follow of those instructions and having a pure SK and a separate Skeleton install

@endigo9740
Copy link
Contributor

endigo9740 commented Oct 13, 2023

@SebasF1349 just did a quick read through. Overall I think this is great. Exactly what I had in mind.

That said, here's a few bits of feedback:

  • I agree with Nik's suggestion above, we need headers - make consideration for Table of Contents targets
  • Try replacing the raw link URLs wit labeled anchors that semantically describe what is being linked to. Before/After:
<p>
    ...so we recommend following the official Tauri guide: <a href="https://tauri.app/v1/guides/getting-started/prerequisites" class="anchor">https://tauri.app/v1/guides/getting-started/prerequisites</a>
</p>
<p>
    ...so we recommend following the <a href="https://tauri.app/v1/guides/getting-started/prerequisites" class="anchor">official Tauri guide</a>
</p>
  • In the "Create your Tauri app" section, it's not immediately clear to me I will be making modifications to the same Skeleton SvelteKit project I setup in the prior step. You might mention that directly. "Follow these instructions to modify your newly created Skeleton project to work with Tauri". Something like that.
  • This is completely optional, but I think a YouTube video of someone explaining this process for a standard SvelteKit app would be valuable for visual folks. There's quite a lot of written steps, so some folks my bounce before they reach the end.
  • Don't forget to include the callout linking to the source code repo.

FYI I'll plan to do a pass through the wording and language a bit when I can. Folks like @Sarenor might be willing to help too!

@endigo9740
Copy link
Contributor

@SebasF1349 I've created the repo for the source project:

https://github.com/skeletonlabs/skeleton-starter-tauri

I've invited you to join this with admin-level access so you have full control. It's set public now. Change whatever you need or what.

@SebasF1349
Copy link
Member Author

SebasF1349 commented Oct 18, 2023

Thanks for your suggestions. I have taken them all into account for this new version. The repo is missing as I still need to add an example on how to communicate the frontend with the backend.

@endigo9740
Copy link
Contributor

@SebasF1349 I've pushed my changes. I tried to preserve the overall structure and instruction, while making updates to the text and styling. In most cases I tried to narrow this down to only the most critical information. This tends to lead to the most success when it comes to teaching. There's likely a few typos, but let me know if this works. And of course, please verify that all instructions remain accurate!

Overall great job with this, it's brilliant. I can't wait to see what folks build with it!

@Sarenor
Copy link
Contributor

Sarenor commented Oct 21, 2023

@SebasF1349
Sorry, block of feedback incoming:

  • The Video Guide and the manual installation blocks are completely separately from each other, aren't they? We might want to better communicate that with something like "you can either follow this video and then our manual instructions or you can follow the completely manual steps outlined below"

  • Open your root layout, found in /src/routes/+layout.svelte, then append the following two lines at the top of the script tag. This will disable both server-side rendering (SSR) and prerendering).

export const prerender = true
export const ssr = false

Does prerender = true really disable prerendering?

Otherwise it's looking excellent and I like it!

@endigo9740 endigo9740 marked this pull request as ready for review October 24, 2023 17:14
@endigo9740 endigo9740 merged commit e5feedc into skeletonlabs:dev Oct 24, 2023
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.

4 participants