doc: Update README according to feedback, add TOC and collapse devfes…

…t callout (julep-ai#599) Signed-off-by: Diwank Singh Tomer <[email protected]>  ---- > [!IMPORTANT] > Enhances `README` files by adding TOC and collapsing DevFest.AI callout, and introduces a GitHub Action for TOC generation. > > - **GitHub Actions**: > - Adds `.github/workflows/doctoc-on-dev-push.yml` to generate TOC on push to `dev` branch using `technote-space/toc-generator@v4`. > - **README Updates**: > - Collapses "Contributors and DevFest.AI Participants" section in `README.md`, `README-CN.md`, and `README-JP.md` using `<details>` and `<summary>` tags. > - Removes Julep 1.0 Alpha release announcement from `README.md`, `README-CN.md`, and `README-JP.md`. > > <sup>This description was created by </sup>[<img alt="Ellipsis" src="https://img.shields.io/badge/Ellipsis-blue?color=175173">](https://www.ellipsis.dev?ref=julep-ai%2Fjulep&utm_source=github&utm_medium=referral)<sup> for b65a1f0. It will automatically update as commits are pushed.</sup>  --------- Signed-off-by: Diwank Singh Tomer <[email protected]> Co-authored-by: vedantsahai18 <[email protected]> Co-authored-by: creatorrr <[email protected]>
supriya46788 · Oct 6, 2024 · d26c977 · d26c977
1 parent 35ec6af
commit d26c977
Show file tree

Hide file tree

Showing 23 changed files with 3,779 additions and 588 deletions.
diff --git a/.github/workflows/doctoc-on-dev-push.yml b/.github/workflows/doctoc-on-dev-push.yml
@@ -0,0 +1,15 @@
+on: push
+
+name: TOC Generator
+jobs:
+  generateTOC:
+    name: TOC Generator
+    runs-on: ubuntu-latest
+    steps:
+      - uses: technote-space/toc-generator@v4
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          MAX_HEADER_LEVEL: 2
+          TOC_TITLE: '<b>📖 Table of Contents</b>'
+          FOLDING: true
+
diff --git a/README-CN.md b/README-CN.md
@@ -28,6 +28,12 @@
 
 *****
 
+> [!TIP]
+> 👨‍💻 来参加 devfest.ai 活动？加入我们的 [Discord](https://discord.com/invite/JTSBGRZrzj) 并查看下方详情。
+
+<details>
+<summary><b>🌟 贡献者和 DevFest.AI 参与者：</b></summary>
+
 ## 🌟 诚邀贡献者！
 
 我们很高兴欢迎新的贡献者加入 Julep 项目！我们创建了几个"适合新手的问题"来帮助您入门。以下是您可以贡献的方式：
@@ -51,31 +57,30 @@
 
 ![Julep DevFest.AI](https://media.giphy.com/media/YjyUeyotft6epaMHtU/giphy.gif)
 
-*****
-
-## 🎉🚀 **激动人心的消息：Julep 1.0 Alpha 版发布！** 🚀🎉
-
-我们很高兴地宣布 **Julep 1.0** 的 **alpha** 版本发布！🥳
-
-🌟 **新特性：**
-- 增强的工作流功能
-- 改进的代理持久性
-- 大量内置工具集成（如 DALL·E、Google 搜索、SendGrid 等）
-- 简化的 API
-
-🧪 尝试使用并帮助塑造 AI 工作流的未来！
-
-> [!NOTE]
-> 在测试阶段，您可以通过 [Discord](https://discord.com/invite/JTSBGRZrzj) 获取 API 密钥。
-
-> [!TIP]
-> 🐛 发现了 bug？有建议？我们很乐意听取您的意见！
->   加入我们的 [Discord](https://discord.com/invite/JTSBGRZrzj) 或提交 [issue](https://github.com/julep-ai/julep/issues)。
-
-请继续关注我们即将发布的稳定版本的更多更新！📢
+</details>
 
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+<details>
+<summary><b>📖 Table of Contents</b></summary>
+
+- [简介](#%E7%AE%80%E4%BB%8B)
+- [特性](#%E7%89%B9%E6%80%A7)
+- [安装](#%E5%AE%89%E8%A3%85)
+- [快速入门指南](#%E5%BF%AB%E9%80%9F%E5%85%A5%E9%97%A8%E6%8C%87%E5%8D%97)
+- [概念](#%E6%A6%82%E5%BF%B5)
+- [理解任务](#%E7%90%86%E8%A7%A3%E4%BB%BB%E5%8A%A1)
+- [高级功能](#%E9%AB%98%E7%BA%A7%E5%8A%9F%E8%83%BD)
+- [SDK 参考](#sdk-%E5%8F%82%E8%80%83)
+- [API 参考](#api-%E5%8F%82%E8%80%83)
+- [示例和教程](#%E7%A4%BA%E4%BE%8B%E5%92%8C%E6%95%99%E7%A8%8B)
+- [贡献](#%E8%B4%A1%E7%8C%AE)
+- [支持和社区](#%E6%94%AF%E6%8C%81%E5%92%8C%E7%A4%BE%E5%8C%BA)
+- [许可证](#%E8%AE%B8%E5%8F%AF%E8%AF%81)
+- [致谢](#%E8%87%B4%E8%B0%A2)
 
-*****
+</details>
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
 ## 简介
 

diff --git a/README-JP.md b/README-JP.md
@@ -28,6 +28,12 @@
 
 *****
 
+> [!TIP]
+> 👨‍💻 devfest.aiイベントに参加されましたか？私たちの[Discord](https://discord.com/invite/JTSBGRZrzj)に参加して、以下の詳細をご確認ください。
+
+<details>
+<summary><b>🌟 コントリビューターとDevFest.AI参加者の皆様へ：</b></summary>
+
 ## 🌟 コントリビューター募集！
 
 Julepプロジェクトに新しいコントリビューターを歓迎します！スタートに役立つ「初心者向けの問題」をいくつか作成しました。以下は、貢献する方法です：
@@ -51,30 +57,30 @@ Julepプロジェクトに新しいコントリビューターを歓迎します
 
 ![Julep DevFest.AI](https://media.giphy.com/media/YjyUeyotft6epaMHtU/giphy.gif)
 
-*****
-
-## 🎉🚀 **エキサイティングなニュース：Julep 1.0 Alphaリリース！** 🚀🎉
-
-**Julep 1.0**の**アルファ**リリースを発表できることを嬉しく思います！🥳
-
-🌟 **新機能：**
-- 強化されたワークフロー機能
-- 改善されたエージェントの持続性
-- 多数の組み込みツール統合（dalle、google検索、sendgridなど）
-- 簡素化されたAPI
-
-🧪 試してみて、AIワークフローの未来を形作る手助けをしましょう！
-
-> [!NOTE]
-> ベータ版の間、APIキーを取得するには[Discord](https://discord.com/invite/JTSBGRZrzj)でお問い合わせください。
-
-> [!TIP]
-> 🐛 バグを見つけましたか？提案がありますか？私たちはあなたの意見を聞きたいです！
->   [Discord](https://discord.com/invite/JTSBGRZrzj)に参加するか、[issue](https://github.com/julep-ai/julep/issues)を開いてください。
+</details>
 
-安定版リリースに向けて、さらに多くの更新情報をお楽しみに！📢
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+<details>
+<summary><b>📖 Table of Contents</b></summary>
+
+- [紹介](#%E7%B4%B9%E4%BB%8B)
+- [特徴](#%E7%89%B9%E5%BE%B4)
+- [インストール](#%E3%82%A4%E3%83%B3%E3%82%B9%E3%83%88%E3%83%BC%E3%83%AB)
+- [クイックスタートガイド](#%E3%82%AF%E3%82%A4%E3%83%83%E3%82%AF%E3%82%B9%E3%82%BF%E3%83%BC%E3%83%88%E3%82%AC%E3%82%A4%E3%83%89)
+- [概念](#%E6%A6%82%E5%BF%B5)
+- [タスクの理解](#%E3%82%BF%E3%82%B9%E3%82%AF%E3%81%AE%E7%90%86%E8%A7%A3)
+- [高度な機能](#%E9%AB%98%E5%BA%A6%E3%81%AA%E6%A9%9F%E8%83%BD)
+- [SDKリファレンス](#sdk%E3%83%AA%E3%83%95%E3%82%A1%E3%83%AC%E3%83%B3%E3%82%B9)
+- [APIリファレンス](#api%E3%83%AA%E3%83%95%E3%82%A1%E3%83%AC%E3%83%B3%E3%82%B9)
+- [例とチュートリアル](#%E4%BE%8B%E3%81%A8%E3%83%81%E3%83%A5%E3%83%BC%E3%83%88%E3%83%AA%E3%82%A2%E3%83%AB)
+- [貢献](#%E8%B2%A2%E7%8C%AE)
+- [サポートとコミュニティ](#%E3%82%B5%E3%83%9D%E3%83%BC%E3%83%88%E3%81%A8%E3%82%B3%E3%83%9F%E3%83%A5%E3%83%8B%E3%83%86%E3%82%A3)
+- [ライセンス](#%E3%83%A9%E3%82%A4%E3%82%BB%E3%83%B3%E3%82%B9)
+- [謝辞](#%E8%AC%9D%E8%BE%9E)
 
-*****
+</details>
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
 ## 紹介