diff --git a/src/content/docs/contribute.mdx b/.github/CONTRIBUTING.md similarity index 88% rename from src/content/docs/contribute.mdx rename to .github/CONTRIBUTING.md index b97b64f9b..9b2a2f9a5 100644 --- a/src/content/docs/contribute.mdx +++ b/.github/CONTRIBUTING.md @@ -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! diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 9e41b7665..000000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -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. diff --git a/README.md b/README.md index 0112c52dc..b372fb9d2 100644 --- a/README.md +++ b/README.md @@ -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 \ No newline at end of file