Skip to content

Commit 2d970c9

Browse files
feat: add documentation for plugins (#1412)
* feat: add documentation for plugins * update prettierignore Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * update contributing guide Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * add notification guide stub Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * update guide Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * revise lifecycle events Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * some more updates and revisions Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * Formatting Signed-off-by: Lorenzo Lewis <lorenzo_lewis@icloud.com> * 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 <lorenzo_lewis@icloud.com> Co-authored-by: Lorenzo Lewis <lorenzo_lewis@icloud.com>
1 parent 8d8a05a commit 2d970c9

File tree

9 files changed

+736
-82
lines changed

9 files changed

+736
-82
lines changed

.github/CONTRIBUTING.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,17 @@ While Tauri 2.0 is still in the prerelease stage people follow these guidelines
5252

5353
### Writing Style
5454

55-
Any ideas? Put them here!
55+
**Dictionary**
56+
57+
| Word | Description |
58+
| -------- | ------------------------------------ |
59+
| app | A Tauri app, prefer over application |
60+
| web view | Where the UI is rendered |
61+
62+
- 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
63+
- Use [title case](https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case) for headings and titles
64+
- Make headings as succinct as possible to help the reader quickly find the content they need
65+
- Use [simple present tense](https://www.grammarly.com/blog/simple-present/) for verbs
5666

5767
### Guide
5868

@@ -90,4 +100,4 @@ Topics that are around understanding something can be written as a blog post (we
90100

91101
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.
92102

93-
Read the [Translating Guide](./TRANSLATING.md) for more information.
103+
Read the [Translating Guide](./TRANSLATING.md) for more information.

.prettierignore

+1
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,4 @@ pnpm-lock.yaml
1414

1515
# Configs
1616
.github
17+
!.github/**.md

astro.config.mjs

+5-1
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ export default defineConfig({
115115
],
116116
},
117117
{
118-
label: 'Workflow',
118+
label: 'Guides',
119119
items: [
120120
{
121121
label: 'Develop',
@@ -137,6 +137,10 @@ export default defineConfig({
137137
label: 'Distribute',
138138
link: '2/guide/distribute',
139139
},
140+
{
141+
label: 'Plugin Development',
142+
link: '2/guide/plugins',
143+
},
140144
],
141145
},
142146
{

src/content/docs/2/guide/commands.mdx

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Commands
3+
---
4+
5+
import Stub from '@components/Stub.astro';
6+
7+
<Stub />

0 commit comments

Comments
 (0)