Skip to content

Commit b22871a

Browse files
author
Laegel
committed
chore(readme)
1 parent f08bc4c commit b22871a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+19
-5295
lines changed

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,23 @@
11
# Tauri Docs
22

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.
44

55
[![Deploys By Netlify](https://www.netlify.com/img/global/badges/netlify-light.svg)](https://www.netlify.com)
66

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).
88

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
1015

1116
```
1217
$ yarn
1318
```
1419

15-
### Local Development
20+
## Local Development
1621

1722
```
1823
$ yarn start
@@ -22,7 +27,7 @@ This command starts a local development server and open up a browser window. Mos
2227

2328
Note that only English language is supported during development phase in order to keep a small build time.
2429

25-
### Build
30+
## Build
2631

2732
```
2833
$ LANGUAGE=${language} yarn build --out-dir ./build/${language}
@@ -40,17 +45,23 @@ supported-languages.js is the module containing the enabled/targeted languages f
4045

4146
Uncomment a language when at least "Getting started" and most of "Usage" docs are translated.
4247

43-
### Deployment
48+
## Deployment
4449

4550
```
4651
$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
4752
```
4853

4954
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.
5055

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.
5263

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)
5465

5566
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
5667

docs/tauri-docs/en/api/js/classes/http.body.md

Lines changed: 0 additions & 128 deletions
This file was deleted.

0 commit comments

Comments
 (0)