From 3edfc1a70e3b90b65b98582cbf70537f783b9d14 Mon Sep 17 00:00:00 2001 From: EC <2340896+cyfyifanchen@users.noreply.github.com> Date: Wed, 11 Sep 2024 00:07:15 +0800 Subject: [PATCH] docs: update welcome page (#2) * 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 --- .github/workflows/pr_name.yml | 10 ++++++---- docs/README.md | 7 +++++-- docs/SUMMARY.md | 2 +- tools/commitlint/commitlint.config.js | 3 +++ 4 files changed, 15 insertions(+), 7 deletions(-) create mode 100644 tools/commitlint/commitlint.config.js diff --git a/.github/workflows/pr_name.yml b/.github/workflows/pr_name.yml index fd2e6321a6..e50c99e784 100644 --- a/.github/workflows/pr_name.yml +++ b/.github/workflows/pr_name.yml @@ -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/pull-request-name-linter-action@v0.5.0 + - uses: actions/checkout@v3 + - name: Install Dependencies + run: npm install @commitlint/config-conventional@16.0.0 + - uses: JulienKode/pull-request-name-linter-action@v0.5.0 + with: + configuration-path: tools/commitlint/commitlint.config.js diff --git a/docs/README.md b/docs/README.md index 7768f86573..47e2257ad7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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! +

Star us to stay updated with Astra Agent

diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 32c85db023..233a248d48 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -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) diff --git a/tools/commitlint/commitlint.config.js b/tools/commitlint/commitlint.config.js new file mode 100644 index 0000000000..84dcb122af --- /dev/null +++ b/tools/commitlint/commitlint.config.js @@ -0,0 +1,3 @@ +module.exports = { + extends: ['@commitlint/config-conventional'], +};