README change
This commit is contained in:
+8
-3
@@ -45,14 +45,19 @@ location /api/ {
|
|||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Usage of AI
|
## Usage of AI
|
||||||
|
|
||||||
Github Copilot CLI was used with the model Claude Haiku 4.5 to generate most of the documentation:
|
Github Copilot CLI was used with the model Claude Haiku 4.5 to generate most of the documentation
|
||||||
|
|
||||||
|
Google Antigravity generated the Sequence Diagrams
|
||||||
|
|
||||||
### Prompt
|
### Prompt
|
||||||
Generate comments for cargo doc describing the indivilual components and create links to relevant structs, functions etc.
|
Generate comments for cargo doc describing the indivilual components and create links to relevant structs, functions etc.
|
||||||
|
|
||||||
|
Generate a sequence diagramm in @[README.md] behind the class diagramms
|
||||||
|
|
||||||
### Output
|
### Output
|
||||||
The comments with `///` or `//!`
|
The comments with `///` or `//!`
|
||||||
I've gone over most of it and modified it to my needs and opinions
|
I've gone over it and modified it to my needs and opinions
|
||||||
|
|
||||||
|
The general structure sequence diagrams above. I've modified and fixed any errors and discrepancys
|
||||||
|
|||||||
@@ -380,6 +380,6 @@ Generate a sequence diagramm in @[README.md] behind the class diagramms
|
|||||||
|
|
||||||
### Output
|
### Output
|
||||||
The comments with `///` or `//!`
|
The comments with `///` or `//!`
|
||||||
I've gone over most of it and modified it to my needs and opinions
|
I've gone over it and modified it to my needs and opinions
|
||||||
|
|
||||||
The general structure sequence diagrams above. I've modified and fixed any errors and discrepancys
|
The general structure sequence diagrams above. I've modified and fixed any errors and discrepancys
|
||||||
|
|||||||
Reference in New Issue
Block a user