Skip to content

Commit 38b82a4

Browse files
authored
Create description-format.md
1 parent 23a26fa commit 38b82a4

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

description-format.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Poggit Plugin Description Formatting Guide
2+
This guide is made for developers to write a better plugin description for their plugins on Poggit.
3+
4+
## 1. Do not include useless information.
5+
A few common types of irrelevant information include:
6+
7+
### Existing information
8+
Plugin name, tagline, icon, license, etc. are already in the page. You don't need to repeat the information.
9+
![](https://i.imgur.com/W894rDX.png)
10+
11+
### Development version information
12+
Users only care about the release build. Don't promote your development build here, so don't put the Poggit-CI badge here.
13+
14+
## 2. Categorize your description into sections
15+
Every section should start with a title (the line begins with a `#` and a space). Each section will be displayed in a separate
16+
tab, and the title will be used as the tab name.
17+
18+
You may want to make a section for each feature, or you may use other methods of organization. Poggit does not force you how to
19+
organize your data, as long as it makes sense to the reader.
20+
21+
## 3. Provide sufficient information
22+
Do not assume users know what your plugin does.
23+
24+
Do not just put a video there. Not everyone wants to watch a video. You may link to a video, but make sure readers who don't watch
25+
video at least have an idea if your plugin will be helpful to them.
26+
27+
You may want to add different languages of description, but you must put an English version, because that's the official language
28+
used in the whole Poggit website.

0 commit comments

Comments
 (0)