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.

Sign up for GitHub

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

Jump to bottom

doc: Update README according to feedback, add TOC and collapse devfest callout #599

Merged
merged 12 commits into from
Oct 6, 2024
Merged

doc: Update README according to feedback, add TOC and collapse devfest callout #599

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
000d1b4
doc: Add claude-generated notebooks for the rest of the ideas
creatorrr Oct 5, 2024
fab18f3
d(cookbooks): minor bug fixes for 5,6,7 ckbks,testing remains
Vedantsahai18 Oct 6, 2024
25e0831
wip: Update README to add TOC and collapse devfest callout
creatorrr Oct 6, 2024
a61082f
chore(docs): update TOC
creatorrr Oct 6, 2024
cd7ce9a
doc: Tweak doctoc settings
creatorrr Oct 6, 2024
3923d48
chore(docs): update TOC
creatorrr Oct 6, 2024
4229e3b
doc: Tweak doctoc settings
creatorrr Oct 6, 2024
89612f3
chore(docs): update TOC
creatorrr Oct 6, 2024
ee4d21f
Merge branch 'd/new-cookbooks' into d/update-readme
creatorrr Oct 6, 2024
fae4ccd
doc: Update README.md according to feedback
creatorrr Oct 6, 2024
1be42ce
chore(docs): update TOC
creatorrr Oct 6, 2024
b65a1f0
doc: Update README.md according to feedback
creatorrr Oct 6, 2024
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
Prev Previous commit
Next Next commit
chore(docs): update TOC
  • Loading branch information
@creatorrr
creatorrr committed Oct 6, 2024
commit 3923d4837708a8ba91ce04dfa2a110c8eda40d46
20 changes: 3 additions & 17 deletions README-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,31 +58,16 @@

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**
<details>
<summary>Table of Contents</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)
- [步骤 1：导入 Julep](#%E6%AD%A5%E9%AA%A4-1%E5%AF%BC%E5%85%A5-julep)
- [步骤 2：初始化代理](#%E6%AD%A5%E9%AA%A4-2%E5%88%9D%E5%A7%8B%E5%8C%96%E4%BB%A3%E7%90%86)
- [步骤 3：与代理聊天](#%E6%AD%A5%E9%AA%A4-3%E4%B8%8E%E4%BB%A3%E7%90%86%E8%81%8A%E5%A4%A9)
- [步骤 4：创建多步骤任务](#%E6%AD%A5%E9%AA%A4-4%E5%88%9B%E5%BB%BA%E5%A4%9A%E6%AD%A5%E9%AA%A4%E4%BB%BB%E5%8A%A1)
- [步骤 5：执行任务](#%E6%AD%A5%E9%AA%A4-5%E6%89%A7%E8%A1%8C%E4%BB%BB%E5%8A%A1)
- [概念](#%E6%A6%82%E5%BF%B5)
- [代理](#%E4%BB%A3%E7%90%86)
- [用户](#%E7%94%A8%E6%88%B7)
- [会话](#%E4%BC%9A%E8%AF%9D)
- [任务](#%E4%BB%BB%E5%8A%A1)
- [工具](#%E5%B7%A5%E5%85%B7)
- [文档](#%E6%96%87%E6%A1%A3)
- [执行](#%E6%89%A7%E8%A1%8C)
- [理解任务](#%E7%90%86%E8%A7%A3%E4%BB%BB%E5%8A%A1)
- [工作流步骤类型](#%E5%B7%A5%E4%BD%9C%E6%B5%81%E6%AD%A5%E9%AA%A4%E7%B1%BB%E5%9E%8B)
- [高级功能](#%E9%AB%98%E7%BA%A7%E5%8A%9F%E8%83%BD)
- [为代理添加工具](#%E4%B8%BA%E4%BB%A3%E7%90%86%E6%B7%BB%E5%8A%A0%E5%B7%A5%E5%85%B7)
- [管理会话和用户](#%E7%AE%A1%E7%90%86%E4%BC%9A%E8%AF%9D%E5%92%8C%E7%94%A8%E6%88%B7)
- [文档集成和搜索](#%E6%96%87%E6%A1%A3%E9%9B%86%E6%88%90%E5%92%8C%E6%90%9C%E7%B4%A2)
- [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)
Expand All @@ -91,6 +76,7 @@
- [许可证](#%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 -->

> [!TIP]
Expand Down
20 changes: 3 additions & 17 deletions README-JP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,31 +58,16 @@ Julepプロジェクトに新しいコントリビューターを歓迎します

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**
<details>
<summary>Table of Contents</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)
- [ステップ1：Julepをインポートする](#%E3%82%B9%E3%83%86%E3%83%83%E3%83%971julep%E3%82%92%E3%82%A4%E3%83%B3%E3%83%9D%E3%83%BC%E3%83%88%E3%81%99%E3%82%8B)
- [ステップ2：エージェントを初期化する](#%E3%82%B9%E3%83%86%E3%83%83%E3%83%972%E3%82%A8%E3%83%BC%E3%82%B8%E3%82%A7%E3%83%B3%E3%83%88%E3%82%92%E5%88%9D%E6%9C%9F%E5%8C%96%E3%81%99%E3%82%8B)
- [ステップ3：エージェントとチャットする](#%E3%82%B9%E3%83%86%E3%83%83%E3%83%973%E3%82%A8%E3%83%BC%E3%82%B8%E3%82%A7%E3%83%B3%E3%83%88%E3%81%A8%E3%83%81%E3%83%A3%E3%83%83%E3%83%88%E3%81%99%E3%82%8B)
- [ステップ4：多段階タスクを作成する](#%E3%82%B9%E3%83%86%E3%83%83%E3%83%974%E5%A4%9A%E6%AE%B5%E9%9A%8E%E3%82%BF%E3%82%B9%E3%82%AF%E3%82%92%E4%BD%9C%E6%88%90%E3%81%99%E3%82%8B)
- [ステップ5：タスクを実行する](#%E3%82%B9%E3%83%86%E3%83%83%E3%83%975%E3%82%BF%E3%82%B9%E3%82%AF%E3%82%92%E5%AE%9F%E8%A1%8C%E3%81%99%E3%82%8B)
- [概念](#%E6%A6%82%E5%BF%B5)
- [エージェント](#%E3%82%A8%E3%83%BC%E3%82%B8%E3%82%A7%E3%83%B3%E3%83%88)
- [ユーザー](#%E3%83%A6%E3%83%BC%E3%82%B6%E3%83%BC)
- [セッション](#%E3%82%BB%E3%83%83%E3%82%B7%E3%83%A7%E3%83%B3)
- [タスク](#%E3%82%BF%E3%82%B9%E3%82%AF)
- [ツール](#%E3%83%84%E3%83%BC%E3%83%AB)
- [ドキュメント](#%E3%83%89%E3%82%AD%E3%83%A5%E3%83%A1%E3%83%B3%E3%83%88)
- [実行](#%E5%AE%9F%E8%A1%8C)
- [タスクの理解](#%E3%82%BF%E3%82%B9%E3%82%AF%E3%81%AE%E7%90%86%E8%A7%A3)
- [ワークフローステップの種類](#%E3%83%AF%E3%83%BC%E3%82%AF%E3%83%95%E3%83%AD%E3%83%BC%E3%82%B9%E3%83%86%E3%83%83%E3%83%97%E3%81%AE%E7%A8%AE%E9%A1%9E)
- [高度な機能](#%E9%AB%98%E5%BA%A6%E3%81%AA%E6%A9%9F%E8%83%BD)
- [エージェントにツールを追加する](#%E3%82%A8%E3%83%BC%E3%82%B8%E3%82%A7%E3%83%B3%E3%83%88%E3%81%AB%E3%83%84%E3%83%BC%E3%83%AB%E3%82%92%E8%BF%BD%E5%8A%A0%E3%81%99%E3%82%8B)
- [セッションとユーザーの管理](#%E3%82%BB%E3%83%83%E3%82%B7%E3%83%A7%E3%83%B3%E3%81%A8%E3%83%A6%E3%83%BC%E3%82%B6%E3%83%BC%E3%81%AE%E7%AE%A1%E7%90%86)
- [ドキュメントの統合と検索](#%E3%83%89%E3%82%AD%E3%83%A5%E3%83%A1%E3%83%B3%E3%83%88%E3%81%AE%E7%B5%B1%E5%90%88%E3%81%A8%E6%A4%9C%E7%B4%A2)
- [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)
Expand All @@ -91,6 +76,7 @@ Julepプロジェクトに新しいコントリビューターを歓迎します
- [ライセンス](#%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 -->

> [!TIP]
Expand Down
20 changes: 3 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,31 +58,16 @@ Exciting news! We're participating in DevFest.AI throughout October 2024! 🗓

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**
<details>
<summary>Table of Contents</summary>

- [Introduction](#introduction)
- [Features](#features)
- [Installation](#installation)
- [Quick Start Guide](#quick-start-guide)
- [Step 1: Import Julep](#step-1-import-julep)
- [Step 2: Initialize the Agent](#step-2-initialize-the-agent)
- [Step 3: Chat with the Agent](#step-3-chat-with-the-agent)
- [Step 4: Create a multi-step Task](#step-4-create-a-multi-step-task)
- [Step 5: Execute the Task](#step-5-execute-the-task)
- [Concepts](#concepts)
- [Agents](#agents)
- [Users](#users)
- [Sessions](#sessions)
- [Tasks](#tasks)
- [Tools](#tools)
- [Documents](#documents)
- [Executions](#executions)
- [Understanding Tasks](#understanding-tasks)
- [Types of Workflow Steps](#types-of-workflow-steps)
- [Advanced Features](#advanced-features)
- [Adding Tools to Agents](#adding-tools-to-agents)
- [Managing Sessions and Users](#managing-sessions-and-users)
- [Document Integration and Search](#document-integration-and-search)
- [SDK Reference](#sdk-reference)
- [API Reference](#api-reference)
- [Examples and Tutorials](#examples-and-tutorials)
Expand All @@ -91,6 +76,7 @@ Exciting news! We're participating in DevFest.AI throughout October 2024! 🗓
- [License](#license)
- [Acknowledgements](#acknowledgements)

</details>
<!-- END doctoc generated TOC please keep comment here to allow auto update -->

> [!TIP]
Expand Down