Skip to content

Commit

Permalink
docs: update welcome page (#2)
Browse files Browse the repository at this point in the history
* docs: updated wording & added TEN paragraph && changed title

* Added an additional paragraph for TEN
* Updated wording to better suit the welcome page.
* Added Astra to the Summary.md

---------
Co-authored-by: Hu Yueh-Wei <[email protected]>
  • Loading branch information
cyfyifanchen authored Sep 10, 2024
1 parent cb986b3 commit 3edfc1a
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 7 deletions.
10 changes: 6 additions & 4 deletions .github/workflows/pr_name.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Install Dependencies
run: npm install @commitlint/config-conventional
- uses: JulienKode/[email protected]
- uses: actions/checkout@v3
- name: Install Dependencies
run: npm install @commitlint/[email protected]
- uses: JulienKode/[email protected]
with:
configuration-path: tools/commitlint/commitlint.config.js
7 changes: 5 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# 🌟 Welcome to TEN

Welcome to TEN! TEN stands for Transformative Extensions Network, an open-source framework for quickly creating multimodal AI agents. It features the all-in-one TEN Manager, written in Rust, supports multimodal protocols, includes the TEN Runtime, offers the Graph Designer, and has an Extension Store to share in community.
Welcome to TEN! TEN stands for Transformative Extensions Network, [ **an open-source framework** ](https://github.com/TEN-framework/ten_framework) for quickly creating multimodal AI agents. It features the all-in-one TEN Manager, written in Rust, supports multimodal protocols, includes the TEN Runtime, offers the Graph Designer, and has an Extension Store to share in community.

Here, you’ll get an overview of all the incredible features TEN offers to help you build engaging and interactive experiences.


Before we get started, please click the [**star button on our GitHub repo**](https://github.com/rte-design/astra.ai) to stay updated with one of the AI agents powered by TEN.
Before we get started, please click the [**star button on our GitHub repo**](https://github.com/TEN-framework/ten_framework) to stay updated with TEN.

TEN’s capabilities are immense, and we’ve harnessed its power to create a real-time multimodal agent that we actively maintain and support. You can explore this agent in our dedicated repository of [ **Astra Agent** ](https://github.com/ten-framework/astra.ai) We’d love to have your support, don’t forget to give it a star as well!


<figure><img src="assets/gif/star_the_repo_confetti.gif" alt=""><figcaption><p>Star us to stay updated with Astra Agent</p></figcaption></figure>
2 changes: 1 addition & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* [Key Concepts](vision/key_concepts.md)
* [Scenarios](vision/application_scenarios.md)

## Getting Started
## Getting Started with Astra

* [Quickstart](getting_started/quickstart.md)
* [Customize Agent](getting_started/customize_your_agent.md)
Expand Down
3 changes: 3 additions & 0 deletions tools/commitlint/commitlint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module.exports = {
extends: ['@commitlint/config-conventional'],
};

0 comments on commit 3edfc1a

Please sign in to comment.