You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-8Lines changed: 19 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,18 +1,23 @@
1
1
# Tauri Docs
2
2
3
-
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
3
+
This website is built using [Docusaurus 2](https://v2.docusaurus.io/) with [MeiliSearch](https://github.com/meilisearch/) for the docs indexation and is deployed by Netlify.
4
4
5
5
[](https://www.netlify.com)
6
6
7
-
You can check the state of a PR by looking at the Deploy preview that Netlify builds and is mentioned in its bot's comment.
7
+
If you seek to change something from **our guides**, please refer to [the docs folder from the Core repository](https://github.com/tauri-apps/tauri/tree/dev/docs).
8
8
9
-
### Installation
9
+
The **API docs** are generated from our [Rust](https://github.com/tauri-apps/tauri/tree/dev/core/tauri) and [TypeScript](https://github.com/tauri-apps/tauri/tree/dev/tooling/api) source code.
10
+
11
+
In the end, as the guides and the API live in the Core repository, tauri-docs just holds the components and various pages that don't need to follow the Core repository version; this way, we don't pollute the Core repository with commits, PRs or issues related to the website only.
12
+
13
+
14
+
## Installation
10
15
11
16
```
12
17
$ yarn
13
18
```
14
19
15
-
###Local Development
20
+
## Local Development
16
21
17
22
```
18
23
$ yarn start
@@ -22,7 +27,7 @@ This command starts a local development server and open up a browser window. Mos
22
27
23
28
Note that only English language is supported during development phase in order to keep a small build time.
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
50
55
51
-
### Contributing
56
+
## Contributing
57
+
58
+
### Writing/fixing docs
59
+
60
+
Feel free to open an issue/a PR if you find something weird in the docs.
61
+
62
+
Your PR once submitted to us, will automatically deploy to a temporary Netlify instance for us or you to review through GitHub's CI/CD checks: you will be able to click on a preview link once the build is ready.
52
63
53
-
Feel free to open an issue/a PR if you find something weird in the docs, your feedback is more than welcome!
64
+
### Internationalization (i18n)
54
65
55
66
We're working with Crowdin to manage translations, if you feel like you want to lend a hand for translations, take a look at the documentation project: https://tauri.crowdin.com/documentation
0 commit comments