tauri-apps/archived-tauri-docs
1
0
Fork 0
mirror of https://github.com/tauri-apps/tauri-docs.git synced 2026-01-31 00:35:16 +01:00
Code Issues Packages Projects Releases Wiki Activity

update contributing

Browse Source 
Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com>
This commit is contained in:
Lorenzo Lewis
2023-08-05 14:35:06 +01:00
parent 86c014871d
commit a371e9e6e4
3 changed files with 21 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/content/docs/contribute.mdx → .github/CONTRIBUTING.md vendored
View File

@@ -1,9 +1,19 @@
---
title: Contribute
i18nReady: true
---
# Contributing
import Stub from '@components/Stub.astro';
Want to contribute to docs? Here's how you can get started:
1. Clone this repo
2. Run `pnpm i`
3. Run `pnpm dev` to start the local server
4. Visit `http://localhost:3000/contribute/` to get started 🥳
Reach out to us on [Discord](https://discord.com/invite/tauri) on the `#dev-documentation` channel if you have any questions!
## Previewing API References
If you'd like to view the API references locally then you must run `pnpm dev:setup` before `pnpm dev` to initialize all of the submodules.
Now you should have the `http://localhost:3000/2/reference/` routes available for preview.
So, you want to write a doc? You've come to the right place!

16
CONTRIBUTING.md
View File

@@ -1,16 +0,0 @@
# Contributing
Want to contribute to docs? Here's how you can get started:
1. Clone this repo
2. Run `pnpm i`
3. Run `pnpm dev` to start the local server
4. Visit `http://localhost:3000/contribute/` to get started 🥳
Reach out to us on [Discord](https://discord.com/invite/tauri) on the `#dev-documentation` channel if you have any questions!
## Previewing API References
If you'd like to view the API references locally then you must run `pnpm dev:setup` before `pnpm dev` to initialize all of the submodules.
Now you should have the `http://localhost:3000/2/reference/` routes available for preview.

26
README.md
View File

@@ -2,26 +2,12 @@
[![Netlify Status](https://api.netlify.com/api/v1/badges/6dc81a5e-32ac-46f4-80c5-198f4a536e26/deploy-status)](https://app.netlify.com/sites/tauri-docs-starlight/deploys)
- Tutorials: Blog post
- How-to Guides: `/src/content/docs/v2/guides`
- Explanation: Blog post
- Reference: `/src/content/docs/v2/reference`
Welcome to the home for Tauri 2.0 documentation - we're excited to have you! ✨
Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
Tauri 2.0 is still in **prerelease** but we're hard at work on preparing and testing the docs for it.
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
There's a few ways you can get involved:
Static assets, like favicons, can be placed in the `public/` directory.
## 🧞 Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
| :------------------------ | :----------------------------------------------- |
| `npm install` | Installs dependencies |
| `npm run dev` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI |
- Check out the [Tauri 2.0 Documentation Roadmap](https://github.com/tauri-apps/tauri-docs/issues/1344) and see if there's anything you'd like to get involved in
- Read the [contributing guidelines](.github/CONTRIBUTING.md) to learn how to get up and running
- [Join us on Discord](https://discord.com/invite/tauri) in the [`#docs` channel](https://discord.com/channels/616186924390023171/662624589037436928) to ask any questions or give feedback