Skip to content

Commit

Permalink
doc: Update README.md according to feedback (#709)
Browse files Browse the repository at this point in the history
Signed-off-by: Diwank Singh Tomer <diwank.singh@gmail.com>

<!-- ELLIPSIS_HIDDEN -->


----

> [!IMPORTANT]
> Update `README.md` and related files to improve Table of Contents
visibility and content clarity.
> 
>   - **README.md**:
> - Changed `<details>` to `<details open>` for Table of Contents
visibility.
>     - Refined Julep's capabilities description for clarity.
> - Added reference to "Understanding Tasks" in the introductory tip.
>     - Included a mermaid sequence diagram to illustrate workflow.
>   - **doctoc-on-push.yml**:
>     - Set `FOLDING` to `false` to keep Table of Contents expanded.
> 
> <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 8bc4453. It will automatically
update as commits are pushed.</sup>


<!-- ELLIPSIS_HIDDEN -->

---------

Signed-off-by: Diwank Singh Tomer <diwank.singh@gmail.com>
Co-authored-by: creatorrr <creatorrr@users.noreply.github.com>
  • Loading branch information
creatorrr and creatorrr authored Oct 19, 2024
1 parent e341fb1 commit 69532b5
Showing 8 changed files with 933 additions and 452 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/doctoc-on-push.yml
Original file line number Diff line number Diff line change
@@ -11,4 +11,4 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
MAX_HEADER_LEVEL: 3
TOC_TITLE: '<h3>📖 Table of Contents</h3>'
FOLDING: true
FOLDING: false
4 changes: 1 addition & 3 deletions README-CN.md
Original file line number Diff line number Diff line change
@@ -62,8 +62,7 @@

<!-- 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><h3>📖 Table of Contents</h3></summary>
<h3>📖 Table of Contents</h3>

- [主要特点](#%E4%B8%BB%E8%A6%81%E7%89%B9%E7%82%B9)
- [Python 快速入门🐍](#python-%E5%BF%AB%E9%80%9F%E5%85%A5%E9%97%A8)
@@ -95,7 +94,6 @@
- [不同的用例](#%E4%B8%8D%E5%90%8C%E7%9A%84%E7%94%A8%E4%BE%8B)
- [不同的外形尺寸](#%E4%B8%8D%E5%90%8C%E7%9A%84%E5%A4%96%E5%BD%A2%E5%B0%BA%E5%AF%B8)

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

## 介绍
4 changes: 1 addition & 3 deletions README-FR.md
Original file line number Diff line number Diff line change
@@ -62,8 +62,7 @@ Des nouvelles passionnantes ! Nous participons au DevFest.AI tout au long du moi

<!-- 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><h3>📖 Table of Contents</h3></summary>
<h3>📖 Table of Contents</h3>

- [Introduction](#introduction)
- [Principales caractéristiques](#principales-caract%C3%A9ristiques)
@@ -102,7 +101,6 @@ Des nouvelles passionnantes ! Nous participons au DevFest.AI tout au long du moi
- [Facteur de forme différent](#facteur-de-forme-diff%C3%A9rent)
- [En résumé](#en-r%C3%A9sum%C3%A9)

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

## Introduction
4 changes: 1 addition & 3 deletions README-JA.md
Original file line number Diff line number Diff line change
@@ -62,8 +62,7 @@ Julep プロジェクトに新しい貢献者を迎えられることを嬉し

<!-- 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><h3>📖 Table of Contents</h3></summary>
<h3>📖 Table of Contents</h3>

- [主な特徴](#%E4%B8%BB%E3%81%AA%E7%89%B9%E5%BE%B4)
- [簡単な例](#%E7%B0%A1%E5%8D%98%E3%81%AA%E4%BE%8B)
@@ -100,7 +99,6 @@ Julep プロジェクトに新しい貢献者を迎えられることを嬉し
- [さまざまなユースケース](#%E3%81%95%E3%81%BE%E3%81%96%E3%81%BE%E3%81%AA%E3%83%A6%E3%83%BC%E3%82%B9%E3%82%B1%E3%83%BC%E3%82%B9)
- [異なるフォームファクタ](#%E7%95%B0%E3%81%AA%E3%82%8B%E3%83%95%E3%82%A9%E3%83%BC%E3%83%A0%E3%83%95%E3%82%A1%E3%82%AF%E3%82%BF)

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

## 導入
Loading

0 comments on commit 69532b5

Please sign in to comment.