From 2a9ed1571a13dbebbd29c882a33eaf78ad889a44 Mon Sep 17 00:00:00 2001 From: 4o1x5 <4o1x5@4o1x5.dev> Date: Thu, 16 May 2024 16:02:32 +0200 Subject: [PATCH] grammar, better spacing for documentation section --- readme.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/readme.md b/readme.md index fdb67a7..28292d8 100644 --- a/readme.md +++ b/readme.md @@ -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_