Skip to content

Commit 12fa00b

Browse files
committed
docs(crowdin-apps): add guidelines for writing effective app descriptions
1 parent 0094861 commit 12fa00b

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

src/content/docs/developer/crowdin-apps/publishing/publishing.mdx

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,43 @@ The app type list:
196196
| File | The custom file format. Should have Manifest. |
197197
| System | The native Crowdin Integration or file extension. |
198198

199+
### Writing Effective App Description
200+
201+
The **Content** field is crucial for helping users understand your app's value. Here are some tips for creating compelling app descriptions that convert visitors into users.
202+
203+
#### Structure Your Content
204+
205+
A well-structured description helps users quickly understand what your app does:
206+
207+
1. **Lead with value** - Start with the main benefit your app provides
208+
2. **Explain how it works** - Describe the key features and workflow
209+
3. **Include use cases** - Help users envision how they'd use your app
210+
4. **Add visuals** - Screenshots make your app more tangible
211+
212+
#### Using Admonitions
213+
214+
You can use admonitions to highlight important information in your app description. The following admonition types are supported:
215+
216+
:::note
217+
Use notes to provide additional context or clarify important details about your app's functionality.
218+
:::
219+
220+
:::tip[Pro Tip]
221+
Tips are great for sharing best practices or suggesting optimal ways to use your app.
222+
:::
223+
224+
:::info
225+
Use info blocks to highlight key features or compatibility information.
226+
:::
227+
228+
:::warning
229+
Warnings help users understand limitations, prerequisites, or potential issues they should be aware of before installation.
230+
:::
231+
232+
:::danger
233+
Use danger admonitions sparingly to highlight critical information, such as actions that cannot be undone or potential data loss scenarios.
234+
:::
235+
199236
### App Pricing
200237

201238
The pricing field describes the app's pricing model in JSON format. It is used only for rendering pricing info on an app page. You should also implement the behavior in your app.

0 commit comments

Comments
 (0)