tasiaiso/tildefriends
1
0
Fork 0
forked from cory/tildefriends
Code Issues Pull Requests Releases Wiki Activity

chore(doc): run and modify formatting rules

Browse Source
This commit is contained in:
Tasia
2024-05-11 21:47:47 +02:00
parent 0751699bc8
commit 85ac8080f4
8 changed files with 45 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
docs/guidelines/documentation-guidelines.md
View File

@ -28,25 +28,25 @@ When writing documentation, the author should have in mind it's target audience:
1. Lines SHOULD NOT be wrapped, to allow clients to dynamically wrap them however they want:
```
This is not very pleasant to read because
the text
is manually wrapped, but the size of the
screen is
smaller than the size the text is wrapped
at. I
need to write even more useless text here
so I get
my point across. Also hi! If you're here
that
means you're either going to contribute to
Tilde
Friends, or that you're reviewing my
stupid
changes. Either way, you're awesome!
```
```text
This is not very pleasant to read because
the text
is manually wrapped, but the size of the
screen is
smaller than the size the text is wrapped
at. I
need to write even more useless text here
so I get
my point across. Also hi! If you're here
that
means you're either going to contribute to
Tilde
Friends, or that you're reviewing my
stupid
changes. Either way, you're awesome!
```
You MAY use one line per sentence.
You MAY use one line per sentence.
2. Lines ending with an `inline code block` SHOULD NOT end with a period.