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

Add config docs for desktop and TUI #123

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

tigerros
Copy link

@tigerros tigerros commented Sep 19, 2023

Closes DioxusLabs/dioxus#1474. This adds:

  • Links to the tauri-bundler docs.
  • Example Dioxus.toml for desktop.

Please take a look at the example Dioxus.toml. I haven't tested it, I just assumed that's what it would look like.


needs to be translated to TOML.

However, Dioxus has Dioxus-specific mandatory TOML fields that we need to include as well.
Copy link
Author

@tigerros tigerros Sep 19, 2023

Choose a reason for hiding this comment

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

I'm not sure if this is required with dx bundle. I can't run dx build without the mandatory fields, so I assume it is required.

name = "Your Awesome App"
default_platform = "desktop"

# You might only be running on desktop, but the following "web" values are still required.
Copy link
Author

@tigerros tigerros Sep 19, 2023

Choose a reason for hiding this comment

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

Not sure if this is required either. I can't run dx build without the web-specific fields, so I assume it is required.

@ealmloff
Copy link
Member

ealmloff commented Oct 15, 2023

I would like to get this documented without just linking users to the Tauri docs. The Tauri docs are often unclear and since we use a different format it can be confusing to see where we override Tauri.

(I can take over if that is not something you are interested in. I just wanted to give you some information on why this isn't merged yet)

@tigerros
Copy link
Author

I would like to get this documented without just linking users to the Tauri docs. The Tauri docs are often unclear and since we use a different format it can be confusing to see where we override Tauri.

Sure, but I don't really know anything about the desktop config, so I'll hand this to someone else. I also just don't like "duplicating" docs, because it makes our docs potentially outdated in the future.

@ealmloff
Copy link
Member

ealmloff commented Oct 15, 2023

I also just don't like "duplicating" docs, because it makes our docs potentially outdated in the future.

We won't get updates as the upstream docs change, but since our tauri-bundle version is pinned to an old version of the library we don't necessarily have the features the new upstream doc updates may talk about.

Right now there will a lot of duplication between the docs, but as Dioxus evolves, our docs will be different anyway. For example, how you tell the bundler what assets to bundle will change with DioxusLabs/dioxus#1369

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.

Document dioxus.toml configuration values (bundling, various private/undocumented fields)
2 participants