docs: Fix collapsible sections
- Make Common Parameters collapsible (as it's lengthy reference material) - Keep CLI Installation visible (important for users to see immediately) - Better information hierarchy
This commit is contained in:
12
README.md
12
README.md
@@ -68,7 +68,7 @@ uv pip install leann
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
<h3>🔧 Build from Source (Recommended for development)</h3>
|
||||
<strong>🔧 Build from Source (Recommended for development)</strong>
|
||||
</summary>
|
||||
|
||||
|
||||
@@ -166,7 +166,8 @@ ollama pull llama3.2:1b
|
||||
|
||||
</details>
|
||||
|
||||
### Common Parameters (Available in All Examples)
|
||||
<details>
|
||||
<summary><strong>📋 Click to expand: Common Parameters (Available in All Examples)</strong></summary>
|
||||
|
||||
All RAG examples share these common parameters:
|
||||
|
||||
@@ -187,6 +188,8 @@ All RAG examples share these common parameters:
|
||||
--top-k N # Number of results to retrieve (default: 20)
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### 📄 Personal Data Manager: Process Any Documents (`.pdf`, `.txt`, `.md`)!
|
||||
|
||||
Ask questions directly about your personal PDFs, documents, and any directory containing your files!
|
||||
@@ -398,8 +401,7 @@ Once the index is built, you can ask questions like:
|
||||
|
||||
LEANN includes a powerful CLI for document processing and search. Perfect for quick document indexing and interactive chat.
|
||||
|
||||
<details>
|
||||
<summary><strong>🔧 Click to expand: Installation Options</strong></summary>
|
||||
### Installation
|
||||
|
||||
If you followed the Quick Start, `leann` is already installed in your virtual environment:
|
||||
```bash
|
||||
@@ -416,8 +418,6 @@ uv tool install leann
|
||||
leann --help
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
|
||||
### Usage Examples
|
||||
|
||||
Reference in New Issue
Block a user