leon.hoppe/HopFrame
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects 1 Releases Wiki Activity

Added inline documentation + fixed small bugs

Browse Source
This commit is contained in:
Leon Hoppe
2024-11-21 16:15:18 +01:00
parent 6d2f7051ee
commit 986c5cebde
13 changed files with 37 additions and 359 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/README.md
View File

@@ -1,13 +1,10 @@
# HopFrame documentation
These sides contain all documentation available for the HopFrame modules
# HopFrame Documentation
## Content
| Topic | Description | Document |
|----------|------------------------------------------------|-----------------------|
| Models | All models used by the HopFrame | [link](./models.md) |
| Services | All services provided by the HopFrame | [link](./services.md) |
| Usage | How to properly implement the HopFrame modules | [link](./usage.md) |
## Dependencies
Both the HopFrame.Api and HopFrame.Web modules are dependent on the HopFrame.Database and HopFrame.Security modules.
So all models and services provided by these modules are available in the other modules as well.
- [x] In code documentation
- [ ] Installation
- [ ] Database usage
- [ ] Authentication usage
- [ ] LogicResult usage
- [ ] Repositories usage
- [ ] AuthService usage
- [ ] AdminPages usage