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

[request] Some contents of the document are extremely irregular, extremely difficult to read, and there are some mistakes #3151

Open
1 task
David-xian66 opened this issue Feb 3, 2025 · 1 comment
Labels
discuss Does this require further discussion before it's dealt with? enhancement Does it add or improve content?

Comments

@David-xian66
Copy link

Question you want answered

Some parts of the document are extremely irregular

Where did you look for an answer?

Currently, I’ve noticed some documentation errors:

URL: https://tauri.app/develop/resources/#accessing-files-in-javascript
In the example configuration for “src-tauri/capabilities/default.json,” the entries “fs:allow-read-text-file” and “fs:allow-resource-read-recursive” no longer exist in the latest version.

If I’m not mistaken, this indicates that the documentation has not been updated in a timely manner, or perhaps this section was overlooked. I would suggest that in the future, you utilize the search function more effectively to quickly identify areas that need updating.

Additionally, I’ve noticed some inconsistencies in the documentation. For example, some configuration examples do not specify which folder the configuration should be placed in. This can be particularly unfriendly for beginners and developers who are eager to get started.

For instance, on https://tauri.app/reference/acl/capability/
There is no mention that these configurations should be written in the “src-tauri\tauri.conf.json” file. This omission can cause unnecessary confusion for beginners.

Page URL

https://tauri.app/develop/resources/#accessing-files-in-javascripthttps://tauri.app/reference/acl/capability/ ,......

Additional context

none

Are you willing to work on this yourself?

  • I want to work on this myself
@David-xian66 David-xian66 added discuss Does this require further discussion before it's dealt with? enhancement Does it add or improve content? labels Feb 3, 2025
@FabianLars
Copy link
Member

In the example configuration for “src-tauri/capabilities/default.json,” the entries “fs:allow-read-text-file” and “fs:allow-resource-read-recursive” no longer exist in the latest version.

They do: https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/permissions/autogenerated/commands/read_text_file.toml / https://github.com/tauri-apps/plugins-workspace/blob/v2/plugins/fs/permissions/autogenerated/base-directories/resource.toml#L9

Additionally, I’ve noticed some inconsistencies in the documentation. For example, some configuration examples do not specify which folder the configuration should be placed in. This can be particularly unfriendly for beginners and developers who are eager to get started.

That i agree with. It's gotten better to be fair, but as you noticed there are still places that need some touch ups.

For instance, on https://tauri.app/reference/acl/capability/
There is no mention that these configurations should be written in the “src-tauri\tauri.conf.json” file. This omission can cause unnecessary confusion for beginners.

They don't really belong into the tauri config (though that's possibly) but more in the json files in src-tauri/capabilities.
Anyway, this is a general problem with the references section i think, all pages there mostly explain the syntax / entries but not the context. I think we can do better in that section but for now i'd always use the pages in the Guides section to understand the concepts first and then use the References if you miss some properties.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss Does this require further discussion before it's dealt with? enhancement Does it add or improve content?
Projects
None yet
Development

No branches or pull requests

2 participants