development, add notes on package structure (#156)

Co-authored-by: Marc Bernard <[email protected]>

src/development-guide/README.md

@@ -15,6 +15,7 @@ Development related information
 - [Development Guidelines](read-first/guidelines.md)
 - [Changelog](read-first/changelog.md)
 - [Versioning](read-first/versioning.md)
+- [Package Structure](read-first/package-structure.md)
 
 ### Serializers
 

src/development-guide/read-first/README.md

@@ -13,3 +13,4 @@ dir:
 - [Development Guidelines](guidelines.md)
 - [Changelog](changelog.md)
 - [Versioning](versioning.md)
+- [Package Structure](package-structure.md)

src/development-guide/read-first/package-structure.md

@@ -0,0 +1,41 @@
+---
+title: Package Structure
+category: read-first
+order: 60
+---
+
+## Package Structure
+
+Various conventions for packages,
+
+### `/src/git/`
+
+Raw git client, uses http package
+
+Does not know about UI, objects or repositories, everything is file based.
+
+Ideally possible to run and use standalone
+
+### `/src/ui/core/`
+
+UI framework
+
+Does not know about objects or repositories
+
+Ideally possible to run and use standalone
+
+### `/src/http/`
+
+Raw http client
+
+Does not know about UI, objects or repositories
+
+Ideally possible to run and use standalone
+
+### `/src/json/`
+
+Don't do any manual changes in this folder, its a renamed copy of https://github.com/sbcgua/ajson via https://github.com/abapGit/ajson_mirror
+
+### `/src/objects/aff/`
+
+Dont do any manual changes in this folder, mirroed from https://github.com/abapGit/aff_mirror