feat: add documentation for plugins (#1412)

* feat: add documentation for plugins * update prettierignore Signed-off-by: Lorenzo Lewis <[email protected]> * update contributing guide Signed-off-by: Lorenzo Lewis <[email protected]> * add notification guide stub Signed-off-by: Lorenzo Lewis <[email protected]> * update guide Signed-off-by: Lorenzo Lewis <[email protected]> * revise lifecycle events Signed-off-by: Lorenzo Lewis <[email protected]> * some more updates and revisions Signed-off-by: Lorenzo Lewis <[email protected]> * Formatting Signed-off-by: Lorenzo Lewis <[email protected]> * resolve some todos * Update src/content/docs/2/guide/plugins/index.mdx * Update src/content/docs/2/guide/plugins/index.mdx * format * The big refactor * Fix broken links, add todo * rework sidebar * typos and minor fixes * fix link * Apply suggestions from code review * why?? * fill "develop an iOS plugin" section * Apply suggestions from code review * enable i18n * fix typo --------- Signed-off-by: Lorenzo Lewis <[email protected]> Co-authored-by: Lorenzo Lewis <[email protected]>
tauri-apps · Sep 7, 2023 · 2d970c9 · 2d970c9
1 parent 8d8a05a
commit 2d970c9
Show file tree

Hide file tree

Showing 9 changed files with 736 additions and 82 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -52,7 +52,17 @@ While Tauri 2.0 is still in the prerelease stage people follow these guidelines
 
 ### Writing Style
 
-Any ideas? Put them here!
+**Dictionary**
+
+| Word     | Description                          |
+| -------- | ------------------------------------ |
+| app      | A Tauri app, prefer over application |
+| web view | Where the UI is rendered             |
+
+- Use an [oxford comma](https://www.grammarly.com/blog/what-is-the-oxford-comma-and-why-do-people-care-so-much-about-it/) in paragraphs, but not in headings and titles
+- Use [title case](https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case) for headings and titles
+- Make headings as succinct as possible to help the reader quickly find the content they need
+- Use [simple present tense](https://www.grammarly.com/blog/simple-present/) for verbs
 
 ### Guide
 
@@ -90,4 +100,4 @@ Topics that are around understanding something can be written as a blog post (we
 
 Thanks for your interest in helping to translate the documentation! Visit the [translation status page](https://beta.tauri.app/contribute/translate-status) to see which docs are ready for translation, need updated, or need reviewed.
 
-Read the [Translating Guide](./TRANSLATING.md) for more information.
+Read the [Translating Guide](./TRANSLATING.md) for more information.
diff --git a/.prettierignore b/.prettierignore
@@ -14,3 +14,4 @@ pnpm-lock.yaml
 
 # Configs
 .github
+!.github/**.md
diff --git a/astro.config.mjs b/astro.config.mjs
@@ -115,7 +115,7 @@ export default defineConfig({
 					],
 				},
 				{
-					label: 'Workflow',
+					label: 'Guides',
 					items: [
 						{
 							label: 'Develop',
@@ -137,6 +137,10 @@ export default defineConfig({
 							label: 'Distribute',
 							link: '2/guide/distribute',
 						},
+						{
+							label: 'Plugin Development',
+							link: '2/guide/plugins',
+						},
 					],
 				},
 				{

diff --git a/src/content/docs/2/guide/commands.mdx b/src/content/docs/2/guide/commands.mdx
@@ -0,0 +1,7 @@
+---
+title: Commands
+---
+
+import Stub from '@components/Stub.astro';
+
+<Stub />