tauri-apps / tauri-docs

The source for all Tauri project documentation.
https://tauri.app
MIT License
749 stars 512 forks source link

[request] in v2 docs, it's hard to find the path to specific config field #2225

Open thewh1teagle opened 1 month ago

thewh1teagle commented 1 month ago

Question you want answered

How do I find the absolute path to config field in tauri.conf.json

Where did you look for an answer?

For instance it's not clear where should I place config/#nsisconfig inside tauri.conf.json. I think the docs should somehow describe on each config field what's the absolute config path to that field and where to add it exactly inside tauri.conf.json

Page URL

https://v2.tauri.app/reference/config

Additional context

No response

Are you willing to work on this yourself?

simonhyll commented 1 month ago

I fully agree that the config reference is hard to navigate. I've toyed with a couple different setups and it's hard to improve what we already have in a way that's sort of "definitively an improvement". My current idea is that we split up the config into a bunch of sub pages, takes a bit of effort is all in the config generator.

Tracking for 2.x simply because the current version is usable, just not as good as we could potentially have it.

simonhyll commented 1 month ago

Mocked up how the sidebar might be used to make the config easier to navigate, perhaps, possibly

Image

thewh1teagle commented 1 month ago

It's not just about navigating the config (although that certainly needs improvement). It's also about the process of eventually finding a specific configuration and then applying it within my own configuration. There needs to be a simple way to understand the path for adding that particular configuration. For instance, app -> nsis -> some -> other -> very -> very -> nested -> config