tauri-apps / tauri-apps/tauri-docs

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

Open
#3,151 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

discuss enhancement
Dominant language
MDX
Stars
1.1k
Forks
887
Avg merge
2d 8h
Merged PRs (30d)
48

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the examples at the resources page’s “Accessing files in JavaScript” section and the ACL capability reference page. Compare the listed permission entries with the latest version and verify where each configuration belongs. Done means outdated entries are corrected and the relevant configuration folder or file is stated clearly for beginners.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.