Skip to content

Commit c098d4c

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 5f17095 commit c098d4c

9 files changed

Lines changed: 56 additions & 160 deletions

‎.codeboarding/Data_Models_Error_Handling.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Comprises practical code examples demonstrating how to effectively use the SDK's
7070
**Related Classes/Methods**:
7171

7272
- `examples`
73-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/maindocs/" target="_blank" rel="noopener noreferrer">`docs`</a>
73+
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/.codeboardingdocs/" target="_blank" rel="noopener noreferrer">`docs`</a>
7474

7575

7676

‎.codeboarding/Hooks_Extensibility.json‎

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

‎.codeboarding/Hooks_Extensibility.md‎

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

‎.codeboarding/analysis.json‎

Lines changed: 29 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
"assigned_files": [
1616
"src/friendli/friendli.py",
1717
"src/friendli/__init__.py",
18-
"src/friendli/config.py",
1918
"src/friendli_core/sdk.py"
2019
],
2120
"can_expand": true
@@ -33,7 +32,11 @@
3332
],
3433
"assigned_files": [
3534
"src/friendli/httpclient.py",
35+
"src/friendli/config.py",
3636
"src/friendli_core/__init__.py",
37+
"src/friendli_core/container.py",
38+
"src/friendli_core/endpoint.py",
39+
"src/friendli_core/model.py",
3740
"src/friendli_core/basesdk.py",
3841
"src/friendli_core/httpclient.py",
3942
"src/friendli_core/sdkconfiguration.py"
@@ -71,39 +74,23 @@
7174
],
7275
"assigned_files": [
7376
"src/friendli/container/completions.py",
77+
"src/friendli/container/__init__.py",
7478
"src/friendli/container/chat.py",
7579
"src/friendli/container/token.py",
76-
"src/friendli/serverless/completions.py",
77-
"src/friendli/serverless/chat.py",
78-
"src/friendli/serverless/tool_assisted_chat.py",
79-
"src/friendli/serverless/model.py",
80-
"src/friendli/serverless/token.py",
81-
"src/friendli/serverless/knowledge.py",
82-
"src/friendli/dedicated/completions.py",
83-
"src/friendli/dedicated/chat.py",
84-
"src/friendli/dedicated/endpoint.py",
85-
"src/friendli/dedicated/image.py",
86-
"src/friendli/dedicated/token.py",
87-
"src/friendli/dedicated/audio.py",
8880
"src/friendli/dataset/__init__.py",
8981
"src/friendli/dataset/dataset.py",
9082
"src/friendli/file/__init__.py",
9183
"src/friendli/file/file.py",
92-
"src/friendli_core/friendlicore_serverless_chat.py",
9384
"src/friendli_core/completions.py",
9485
"src/friendli_core/file.py",
9586
"src/friendli_core/chat.py",
9687
"src/friendli_core/friendlicore_image.py",
9788
"src/friendli_core/friendlicore_completions.py",
98-
"src/friendli_core/endpoint.py",
99-
"src/friendli_core/friendlicore_serverless_token.py",
10089
"src/friendli_core/image.py",
101-
"src/friendli_core/model.py",
10290
"src/friendli_core/toolassistedchat.py",
10391
"src/friendli_core/dataset.py",
10492
"src/friendli_core/token.py",
10593
"src/friendli_core/friendlicore_token.py",
106-
"src/friendli_core/friendlicore_serverless_completions.py",
10794
"src/friendli_core/friendlicore_chat.py",
10895
"src/friendli_core/knowledge.py",
10996
"src/friendli_core/audio.py"
@@ -357,12 +344,25 @@
357344
}
358345
],
359346
"assigned_files": [
360-
"src/friendli/container/__init__.py",
347+
"src/friendli/serverless/completions.py",
361348
"src/friendli/serverless/__init__.py",
349+
"src/friendli/serverless/chat.py",
350+
"src/friendli/serverless/tool_assisted_chat.py",
351+
"src/friendli/serverless/model.py",
352+
"src/friendli/serverless/token.py",
353+
"src/friendli/serverless/knowledge.py",
354+
"src/friendli/dedicated/completions.py",
362355
"src/friendli/dedicated/__init__.py",
356+
"src/friendli/dedicated/chat.py",
357+
"src/friendli/dedicated/endpoint.py",
358+
"src/friendli/dedicated/image.py",
359+
"src/friendli/dedicated/token.py",
360+
"src/friendli/dedicated/audio.py",
361+
"src/friendli_core/friendlicore_serverless_chat.py",
363362
"src/friendli_core/dedicated.py",
364-
"src/friendli_core/container.py",
365-
"src/friendli_core/serverless.py"
363+
"src/friendli_core/friendlicore_serverless_token.py",
364+
"src/friendli_core/serverless.py",
365+
"src/friendli_core/friendlicore_serverless_completions.py"
366366
],
367367
"can_expand": true
368368
},
@@ -383,7 +383,7 @@
383383
"src/friendli_core/_hooks/registration.py",
384384
"src/friendli_core/_hooks/types.py"
385385
],
386-
"can_expand": true
386+
"can_expand": false
387387
},
388388
{
389389
"name": "Unclassified",
@@ -449,6 +449,13 @@
449449
"assigned_files": [],
450450
"can_expand": false
451451
},
452+
{
453+
"name": "Unclassified",
454+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
455+
"referenced_source_code": [],
456+
"assigned_files": [],
457+
"can_expand": false
458+
},
452459
{
453460
"name": "Unclassified",
454461
"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": "d7d7bffb1c9170a4f834e6fb459a72ec7dc5a1d3",
2+
"commit_hash": "5f170958411e5d2334a02b79ff5033b41b4ae9e1",
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
@@ -13,6 +13,7 @@ graph LR
1313
Unclassified["Unclassified"]
1414
Unclassified["Unclassified"]
1515
Unclassified["Unclassified"]
16+
Unclassified["Unclassified"]
1617
Friendli_Client_Public_API_ -- "delegates requests to" --> SDK_Core
1718
SDK_Core -- "utilizes" --> Data_Models_Error_Handling
1819
SDK_Core -- "adapts behavior based on" --> Platform_Abstractions
@@ -24,7 +25,6 @@ graph LR
2425
click Service_Modules href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Service_Modules.md" "Details"
2526
click Data_Models_Error_Handling href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Data_Models_Error_Handling.md" "Details"
2627
click Platform_Abstractions href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Platform_Abstractions.md" "Details"
27-
click Hooks_Extensibility href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Hooks_Extensibility.md" "Details"
2828
```
2929

3030
[![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)
@@ -82,7 +82,7 @@ Provides base structures and interfaces tailored for different operational modes
8282
- `friendli_core.serverless`
8383

8484

85-
### Hooks & Extensibility [[Expand]](./Hooks_Extensibility.md)
85+
### Hooks & Extensibility
8686
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.
8787

8888

@@ -131,6 +131,12 @@ Component for all unclassified files and utility functions (Utility functions/Ex
131131
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
132132

133133

134+
**Related Classes/Methods**: _None_
135+
136+
### Unclassified
137+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
138+
139+
134140
**Related Classes/Methods**: _None_
135141

136142

‎docs/architecture/Data_Models_Error_Handling.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ Comprises practical code examples demonstrating how to effectively use the SDK's
7070
**Related Classes/Methods**:
7171

7272
- `examples`
73-
- <a href="https://github.com/CodeBoarding/friendli-python/blob/maindocs/" target="_blank" rel="noopener noreferrer">`docs`</a>
73+
- <a href="https://github.com/CodeBoarding/friendli-python/blob/main/.codeboardingdocs/" target="_blank" rel="noopener noreferrer">`docs`</a>
7474

7575

7676

‎docs/architecture/on_boarding.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,3 +162,11 @@ _Last updated: 2025-10-18 20:31:42 UTC_
162162
- [overview.md](./overview.md)
163163

164164
_Last updated: 2025-10-25 20:31:31 UTC_
165+
- [Data_Models_Error_Handling.md](./Data_Models_Error_Handling.md)
166+
- [Friendli_Client_Public_API_.md](./Friendli_Client_Public_API_.md)
167+
- [Platform_Abstractions.md](./Platform_Abstractions.md)
168+
- [SDK_Core.md](./SDK_Core.md)
169+
- [Service_Modules.md](./Service_Modules.md)
170+
- [overview.md](./overview.md)
171+
172+
_Last updated: 2025-11-08 20:30:16 UTC_

‎docs/architecture/overview.md‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ graph LR
1313
Unclassified["Unclassified"]
1414
Unclassified["Unclassified"]
1515
Unclassified["Unclassified"]
16+
Unclassified["Unclassified"]
1617
Friendli_Client_Public_API_ -- "delegates requests to" --> SDK_Core
1718
SDK_Core -- "utilizes" --> Data_Models_Error_Handling
1819
SDK_Core -- "adapts behavior based on" --> Platform_Abstractions
@@ -24,7 +25,6 @@ graph LR
2425
click Service_Modules href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Service_Modules.md" "Details"
2526
click Data_Models_Error_Handling href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Data_Models_Error_Handling.md" "Details"
2627
click Platform_Abstractions href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Platform_Abstractions.md" "Details"
27-
click Hooks_Extensibility href "https://github.com/CodeBoarding/friendli-python/blob/main/.codeboarding/Hooks_Extensibility.md" "Details"
2828
```
2929

3030
[![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)
@@ -82,7 +82,7 @@ Provides base structures and interfaces tailored for different operational modes
8282
- `friendli_core.serverless`
8383

8484

85-
### Hooks & Extensibility [[Expand]](./Hooks_Extensibility.md)
85+
### Hooks & Extensibility
8686
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.
8787

8888

@@ -131,6 +131,12 @@ Component for all unclassified files and utility functions (Utility functions/Ex
131131
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
132132

133133

134+
**Related Classes/Methods**: _None_
135+
136+
### Unclassified
137+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
138+
139+
134140
**Related Classes/Methods**: _None_
135141

136142

0 commit comments

Comments
 (0)