Skip to content

Commit af5799d

Browse files
actions-useractions-user
committed
docs: update codeboarding architecture documentation
## 📚 Architecture Documentation Update This commit contains updated documentation files fetched from the CodeBoarding service and copied to the architecture documentation section. ### 📊 Summary - Documentation files created/updated: 6 - JSON files created/updated: 7 - Documentation directory: .codeboarding/ - JSON directory: .codeboarding/ - Output format: .md - Repository analyzed: https://github.com/CodeBoarding/friendli-python - Destination: docs/architecture/ The generated .md files have been automatically copied to the architecture documentation section and referenced in on_boarding.md. 🤖 This commit was automatically generated by the CodeBoarding documentation update workflow.
1 parent 6fa0232 commit af5799d

File tree

7 files changed

+42
-88
lines changed

7 files changed

+42
-88
lines changed

‎.codeboarding/Hooks_Extensibility.json‎

Lines changed: 0 additions & 40 deletions
This file was deleted.

‎.codeboarding/Hooks_Extensibility.md‎

Lines changed: 0 additions & 33 deletions
This file was deleted.

‎.codeboarding/analysis.json‎

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,10 @@
3131
}
3232
],
3333
"assigned_files": [
34-
"src/friendli_core/__init__.py",
34+
"src/friendli/httpclient.py",
35+
"src/friendli/config.py",
3536
"src/friendli_core/basesdk.py",
37+
"src/friendli_core/httpclient.py",
3638
"src/friendli_core/sdkconfiguration.py"
3739
],
3840
"can_expand": true
@@ -68,16 +70,17 @@
6870
],
6971
"assigned_files": [
7072
"src/friendli/container/completions.py",
71-
"src/friendli/container/__init__.py",
7273
"src/friendli/container/chat.py",
7374
"src/friendli/container/token.py",
7475
"src/friendli/serverless/completions.py",
7576
"src/friendli/serverless/chat.py",
7677
"src/friendli/serverless/tool_assisted_chat.py",
78+
"src/friendli/serverless/model.py",
7779
"src/friendli/serverless/token.py",
7880
"src/friendli/serverless/knowledge.py",
7981
"src/friendli/dedicated/completions.py",
8082
"src/friendli/dedicated/chat.py",
83+
"src/friendli/dedicated/endpoint.py",
8184
"src/friendli/dedicated/image.py",
8285
"src/friendli/dedicated/token.py",
8386
"src/friendli/dedicated/audio.py",
@@ -92,8 +95,10 @@
9295
"src/friendli_core/chat.py",
9396
"src/friendli_core/friendlicore_image.py",
9497
"src/friendli_core/friendlicore_completions.py",
98+
"src/friendli_core/endpoint.py",
9599
"src/friendli_core/friendlicore_serverless_token.py",
96100
"src/friendli_core/image.py",
101+
"src/friendli_core/model.py",
97102
"src/friendli_core/toolassistedchat.py",
98103
"src/friendli_core/dataset.py",
99104
"src/friendli_core/token.py",
@@ -119,8 +124,6 @@
119124
"assigned_files": [
120125
"src/friendli/models.py",
121126
"src/friendli/types.py",
122-
"src/friendli/serverless/model.py",
123-
"src/friendli_core/model.py",
124127
"src/friendli_core/models/containerdetokenizationop.py",
125128
"src/friendli_core/models/splitinfo.py",
126129
"src/friendli_core/models/dedicatedgetendpointstatusop.py",
@@ -354,11 +357,10 @@
354357
}
355358
],
356359
"assigned_files": [
360+
"src/friendli/container/__init__.py",
357361
"src/friendli/serverless/__init__.py",
358362
"src/friendli/dedicated/__init__.py",
359-
"src/friendli/dedicated/endpoint.py",
360363
"src/friendli_core/dedicated.py",
361-
"src/friendli_core/endpoint.py",
362364
"src/friendli_core/serverless.py"
363365
],
364366
"can_expand": true
@@ -380,18 +382,16 @@
380382
"src/friendli_core/_hooks/registration.py",
381383
"src/friendli_core/_hooks/types.py"
382384
],
383-
"can_expand": true
385+
"can_expand": false
384386
},
385387
{
386388
"name": "Unclassified",
387389
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
388390
"referenced_source_code": [],
389391
"assigned_files": [
390392
"src/friendli/utils.py",
391-
"src/friendli/httpclient.py",
392-
"src/friendli/config.py",
393+
"src/friendli_core/__init__.py",
393394
"src/friendli_core/_version.py",
394-
"src/friendli_core/httpclient.py",
395395
"src/friendli_core/utils/metadata.py",
396396
"src/friendli_core/utils/__init__.py",
397397
"src/friendli_core/utils/forms.py",
@@ -498,6 +498,13 @@
498498
"assigned_files": [],
499499
"can_expand": false
500500
},
501+
{
502+
"name": "Unclassified",
503+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
504+
"referenced_source_code": [],
505+
"assigned_files": [],
506+
"can_expand": false
507+
},
501508
{
502509
"name": "Unclassified",
503510
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",

‎.codeboarding/codeboarding_version.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"commit_hash": "e7eed5910100aa72f1415e6a5c01b1c6b40c0f4d",
2+
"commit_hash": "6fa0232f76cebbfe1987ee0dd5a0d0b997533a5e",
33
"code_boarding_version": "0.2.0"
44
}

‎.codeboarding/overview.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ graph LR
2020
Unclassified["Unclassified"]
2121
Unclassified["Unclassified"]
2222
Unclassified["Unclassified"]
23+
Unclassified["Unclassified"]
2324
Friendli_Client_Public_API_ -- "delegates requests to" --> SDK_Core
2425
SDK_Core -- "utilizes" --> Data_Models_Error_Handling
2526
SDK_Core -- "adapts behavior based on" --> Platform_Abstractions
@@ -31,7 +32,6 @@ graph LR
3132
click Service_Modules href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Service_Modules.md" "Details"
3233
click Data_Models_Error_Handling href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Data_Models_Error_Handling.md" "Details"
3334
click Platform_Abstractions href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Platform_Abstractions.md" "Details"
34-
click Hooks_Extensibility href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Hooks_Extensibility.md" "Details"
3535
```
3636

3737
[![CodeBoarding](https://img.shields.io/badge/Generated%20by-CodeBoarding-9cf?style=flat-square)](https://github.com/CodeBoarding/CodeBoarding)[![Demo](https://img.shields.io/badge/Try%20our-Demo-blue?style=flat-square)](https://www.codeboarding.org/diagrams)[![Contact](https://img.shields.io/badge/Contact%20us%20-%20contact@codeboarding.org-lightgrey?style=flat-square)](mailto:contact@codeboarding.org)
@@ -89,7 +89,7 @@ Provides base structures and interfaces tailored for different operational modes
8989
- `friendli_core.serverless`
9090

9191

92-
### Hooks & Extensibility [[Expand]](./Hooks_Extensibility.md)
92+
### Hooks & Extensibility
9393
Offers an extensible mechanism for injecting custom logic at various stages of the request/response lifecycle, allowing for pre-processing, post-processing, and error handling customization.
9494

9595

@@ -180,6 +180,12 @@ Component for all unclassified files and utility functions (Utility functions/Ex
180180
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
181181

182182

183+
**Related Classes/Methods**: _None_
184+
185+
### Unclassified
186+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
187+
188+
183189
**Related Classes/Methods**: _None_
184190

185191

‎docs/architecture/on_boarding.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,3 +223,11 @@ _Last updated: 2025-12-13 20:34:17 UTC_
223223
- [overview.md](./overview.md)
224224

225225
_Last updated: 2025-12-20 20:34:05 UTC_
226+
- [Data_Models_Error_Handling.md](./Data_Models_Error_Handling.md)
227+
- [Friendli_Client_Public_API_.md](./Friendli_Client_Public_API_.md)
228+
- [Platform_Abstractions.md](./Platform_Abstractions.md)
229+
- [SDK_Core.md](./SDK_Core.md)
230+
- [Service_Modules.md](./Service_Modules.md)
231+
- [overview.md](./overview.md)
232+
233+
_Last updated: 2025-12-27 20:35:57 UTC_

‎docs/architecture/overview.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ graph LR
2020
Unclassified["Unclassified"]
2121
Unclassified["Unclassified"]
2222
Unclassified["Unclassified"]
23+
Unclassified["Unclassified"]
2324
Friendli_Client_Public_API_ -- "delegates requests to" --> SDK_Core
2425
SDK_Core -- "utilizes" --> Data_Models_Error_Handling
2526
SDK_Core -- "adapts behavior based on" --> Platform_Abstractions
@@ -31,7 +32,6 @@ graph LR
3132
click Service_Modules href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Service_Modules.md" "Details"
3233
click Data_Models_Error_Handling href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Data_Models_Error_Handling.md" "Details"
3334
click Platform_Abstractions href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Platform_Abstractions.md" "Details"
34-
click Hooks_Extensibility href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Hooks_Extensibility.md" "Details"
3535
```
3636

3737
[![CodeBoarding](https://img.shields.io/badge/Generated%20by-CodeBoarding-9cf?style=flat-square)](https://github.com/CodeBoarding/CodeBoarding)[![Demo](https://img.shields.io/badge/Try%20our-Demo-blue?style=flat-square)](https://www.codeboarding.org/diagrams)[![Contact](https://img.shields.io/badge/Contact%20us%20-%20contact@codeboarding.org-lightgrey?style=flat-square)](mailto:contact@codeboarding.org)
@@ -89,7 +89,7 @@ Provides base structures and interfaces tailored for different operational modes
8989
- `friendli_core.serverless`
9090

9191

92-
### Hooks & Extensibility [[Expand]](./Hooks_Extensibility.md)
92+
### Hooks & Extensibility
9393
Offers an extensible mechanism for injecting custom logic at various stages of the request/response lifecycle, allowing for pre-processing, post-processing, and error handling customization.
9494

9595

@@ -180,6 +180,12 @@ Component for all unclassified files and utility functions (Utility functions/Ex
180180
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
181181

182182

183+
**Related Classes/Methods**: _None_
184+
185+
### Unclassified
186+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
187+
188+
183189
**Related Classes/Methods**: _None_
184190

185191

0 commit comments

Comments
 (0)