LearningPulse/documentation
LearningPulse/documentation
Archived
4
0
Fork 0
Code Issues 1 Pull requests Packages Projects Releases Wiki Activity

grammar, better spacing for documentation section

Browse source
This commit is contained in:
2005 2024-05-16 16:02:32 +02:00
parent 188b9c1879
commit 2a9ed1571a
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
readme.md
View file

@ -197,8 +197,9 @@ public Image getImage(URL url, String name) {
# Frontend
Documenting the frontend is quite hard, but since there will be also logic hid inside the frontend that too will need to be documented.
For methods and classes, JSDoc for javascript is the perfect fit.
Documenting the frontend is quite hard, but since there will be state management and complicated classes for managing data it has to be all written down.
**For methods and classes, JSDoc for javascript is the perfect fit.**
```typescript
/**
@ -213,7 +214,8 @@ function is_even(number): boolean {
}
```
For user action descriptions and flow charts [Mermaid](https://github.com/mermaid-js/mermaid) has to be used. We can describe actions that are then generated into SVGs, PNGs, or other formats. They neatly integrate into Forgejo too.
**For user action descriptions and flow charts [Mermaid](https://github.com/mermaid-js/mermaid) has to be used.**
We can describe actions that are then generated into SVGs, PNGs, or other formats. It also neatly integrates into Forgejo.
_An example of a state description_