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

[build-docs]: How to build your Tauri app documentation #2189

Draft
wants to merge 6 commits into
base: v2
Choose a base branch
from

Conversation

gabrielucido
Copy link
Contributor

@gabrielucido gabrielucido commented May 23, 2024

What kind of changes does this PR include?

  • New build (how to generate the bundles not how to develop/build an app) documentation

Description

Check List

  • Added Build section to the develop docs
  • Build Overview page
  • Build Prerequisites page
  • Bundle Window Installer page
  • Bundle Linux Installer page
  • Bundle Mac Installer page
  • Bundle for Android page
  • Bundle for iOS page
  • A Next section at the end of each bundle platform page that links to the Distribute Docs

@gabrielucido gabrielucido requested a review from a team as a code owner May 23, 2024 14:36
Copy link

netlify bot commented May 23, 2024

Deploy Preview for tauri-v2 failed.

Built without sensitive environment variables

Name Link
🔨 Latest commit a77c69a
🔍 Latest deploy log https://app.netlify.com/sites/tauri-v2/deploys/66547d8473bed100089fdeb4

@gabrielucido gabrielucido changed the title [build]: [build]: How to build your Tauri app documentation May 23, 2024
@gabrielucido gabrielucido marked this pull request as draft May 23, 2024 14:36
@gabrielucido gabrielucido changed the title [build]: How to build your Tauri app documentation [build-docs]: How to build your Tauri app documentation May 23, 2024
@vasfvitor
Copy link
Contributor

you can, (and should, IMO) check v1 docs build section https://tauri.app/v1/guides/building/ and match to the migration guide https://v2.tauri.app/start/migrate/from-tauri-1/ to check for stuff that changed, it will be mostly tauri.conf settings and the use of plugins

If you have trouble in any part of the process please ask

notice that "sidecar" and "resources" is now on develop section, at least sidecar it is

could you move those url fixes to the other PR? are they needed here?

Copy link
Contributor

@simonhyll simonhyll left a comment

Choose a reason for hiding this comment

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

Imo we shouldn't have a "Build" section, all the docs in that section can be put in either "Distribute" or "Develop" instead. The information is relevant but the structure and format is old. Part of the reason I don't feel it makes sense is because you always either build in development or you build for distribution, there's not really a step in-between when you build. So we should have articles about building and debugging in Develop, and if you distribute binaries then that's what the Distribute section is all about.

Also, what is the prerequisites page for? That'd just be the general prerequisites we have in Quick Start?

We could have Develop > Build and Distribute > Build perhaps? I don't want the sidebar to get too bloated, it's already pretty huge

@simonhyll simonhyll added the enhancement Does it add or improve content? label May 23, 2024
@simonhyll simonhyll added this to the Version 2.0 milestone May 23, 2024
@tweidinger
Copy link
Contributor

I think all of the mentioned guides are already live. Feel free to correct me on what is still missing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Does it add or improve content?
Projects
Status: 🏗️ In progress
Development

Successfully merging this pull request may close these issues.

[docs] gettings started guide: how build my Tauri app
4 participants