tauri-apps / tauri-apps/tauri-docs

Add a "Tips" section

Open
#73 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Create this section in the docs (Usage > Tips).
This section is supposed to bring useful clues to consumers so they can learn how to deal with some edge-cases, for example.

Add the following items:

And a word of advice: don't rely on remote resources. That will make your app boot slower and if either the user or remote service are offline then infinitely slower.
It's one of the key differences between an app and a website.
Also remote assets are always a vulnerability.

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 in the documentation's Usage section and inspect how neighboring sections are structured. Add a Tips subsection containing the three supplied items, including the linked reference, and verify that the completed section renders correctly in the documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.