Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add development process part #70

Merged
merged 1 commit into from
Oct 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
## TEN framework

* [Overview](ten_framework/concept_overview.md)
* [Development Process](ten_framework/development_process.md)
* [Preparation](ten_framework/preparation.md)
* [Version System](ten_framework/version_system.md)
* [Metadata System](ten_framework/metadata_system.md)
Expand Down
20 changes: 20 additions & 0 deletions docs/ten_framework/development_process.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Development Process

Basically, by using the TEN framework to complete the desired scenarios, there are two development approaches or perspectives:

1. From small extensions to large scenarios
2. From large scenarios to small extensions

**Note:** Regardless of which of these two development approaches you take, you can either write your own extensions from scratch or download pre-built extensions from the TEN cloud store.

In the first approach, **from small extensions to large scenarios**, the development process typically follows these steps:

1. Develop extensions.
2. Assemble the extensions into a graph, and further create an agent, for example, [TEN-Agent](https://github.com/TEN-framework/TEN-Agent).

In the second approach, **from large scenarios to small extensions**, the development process typically follows these steps:

1. Select the desired agent template, for example, [TEN-Agent](https://github.com/TEN-framework/TEN-Agent).
2. Replace some of the extensions within the chosen agent template with your own.

In this second development approach, you can ensure that the behavior of the replaced extension matches the original one by using the framework for **standalone testing** of extensions. In this process, the developer only needs to understand concepts related to TEN extensions, including how to independently develop and test a TEN extension. All other TEN-related concepts outside of extension development and testing do not need to be understood, as these concepts are encapsulated within the selected TEN agent.
2 changes: 1 addition & 1 deletion docs/ten_framework/test_system.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## For Users of the TEN Framework

(To be added.)
### Standalone Testing of Extension

## For Developers of the TEN Framework

Expand Down
Loading