From 42bd41f33ec050b5ccf75d69e0086391d98e690b Mon Sep 17 00:00:00 2001 From: zachary62 Date: Fri, 27 Dec 2024 21:57:50 +0000 Subject: [PATCH] docs --- README.md | 4 ++-- {docs => assets}/minillmflow.jpg | Bin {docs => assets}/prompt | 0 docs/_config.yml | 18 ++++++++++++++++++ 4 files changed, 20 insertions(+), 2 deletions(-) rename {docs => assets}/minillmflow.jpg (100%) rename {docs => assets}/prompt (100%) create mode 100644 docs/_config.yml diff --git a/README.md b/README.md index 8026501..9245672 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ A 100-line minimalist LLM framework for agents, task decomposition, RAG, etc. - Install via ```pip install minillmflow```, or just copy the [source](minillmflow/__init__.py) (only 100 lines) -- **Pro tip:** Build LLM apps with LLMs assistants (ChatGPT, Claude, etc.) via [this prompt](docs/prompt) +- **Pro tip:** Build LLM apps with LLMs assistants (ChatGPT, Claude, etc.) via [this prompt](assets/prompt) ## Why Mini LLM Flow? @@ -27,7 +27,7 @@ Hence, I built this framework that lets LLMs focus on what matters. It turns out
- +
## Example diff --git a/docs/minillmflow.jpg b/assets/minillmflow.jpg similarity index 100% rename from docs/minillmflow.jpg rename to assets/minillmflow.jpg diff --git a/docs/prompt b/assets/prompt similarity index 100% rename from docs/prompt rename to assets/prompt diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000..814a489 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,18 @@ +# Basic site settings +title: Mini LLM Flow +description: Minimalist LLM Framework in 100 Lines, Enabling LLMs to Program Themselves + +# Theme settings +remote_theme: just-the-docs/just-the-docs + +# Navigation +nav_sort: case_sensitive +search_enabled: true + +# Aux links (shown in upper right) +aux_links: + "View on GitHub": + - "//github.com/zachary62/miniLLMFlow" + +# Color scheme +color_scheme: light \ No newline at end of file