Skip to content

Commit 15f8a36

Browse files
committed
docs: initialize LLM Wiki structure for better documentation maintenance
- Create docs/wiki/ directory with full folder structure - Add SCHEMA.md, index.md and contributing guidelines - Set up core/, features/, examples/, types/ and subdirectories - Prepare for LLM-powered living documentation (Llama class, multi-modal chat handlers, vision/audio examples, etc.) - Include .gitkeep files to preserve empty directories This lays the foundation for a modern, maintainable wiki that will replace outdated static docs. Future commits will populate pages with up-to-date content generated from latest source code. Signed-off-by: JamePeng <jame_peng@sina.com>
1 parent 3984ab5 commit 15f8a36

35 files changed

Lines changed: 45 additions & 0 deletions

docs/wiki/.gitkeep

Whitespace-only changes.

docs/wiki/SCHEMA.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# LLM Wiki Schema – llama-cpp-python
2+
3+
**Purpose**: Maintain a living, always-up-to-date, structured documentation wiki for the llama-cpp-python library using LLMs as the primary maintainer.
4+
5+
**Core Principles**:
6+
- The source of truth is the latest code in `llama_cpp/` (especially `llama.py`, `llama_chat_format.py`, `llama_cpp.py`, `llama_types.py`, `mtmd_cpp.py`, `_internals.py`, `_ggml.py`).
7+
- Never invent parameters or behavior. Always read the current source code before writing/updating a page.
8+
- All examples must be complete, runnable with the latest API, and include necessary imports.
9+
- Clearly mark any deprecated/old usage with a warning and show the modern replacement.
10+
- Use internal wiki links (e.g. [[Llama]], [[Qwen35ChatHandler]]) for cross-referencing.
11+
- Keep pages concise, professional, and user-friendly.
12+
13+
**Page Types and Templates**:
14+
15+
1. **Class / Module Page** (e.g. core/Llama.md)
16+
- Frontmatter (YAML):
17+
```yaml
18+
---
19+
title: Llama Class
20+
class_name: Llama
21+
last_updated: YYYY-MM-DD
22+
version_target: "latest"
23+
---
24+
```
25+
- Sections (in order):
26+
- Overview
27+
- Constructor (`__init__`) – full parameter table with types, defaults, and explanations
28+
- Core Methods (with signatures and examples)
29+
- Best Practices & Common Patterns
30+
- Deprecated / Changed APIs (with migration notes)
31+
- Related Links
32+
33+
2. **Feature Page** (features/xxx.md)
34+
- Overview, When to use, Code examples, Limitations, Related features
35+
36+
3. **Example Page** (examples/xxx.md)
37+
- Goal, Prerequisites, Complete runnable code block, Expected output, Tips
38+
39+
**Update Rules**:
40+
- Before updating any page, the LLM must read the relevant source files.
41+
- Update the `last_updated` date.
42+
- If a new feature (e.g. new ChatHandler, new sampler) appears in code, create or expand the corresponding page.
43+
- Maintain a high standard of readability and accuracy.
44+
45+
This schema is the contract. All generated content must follow it.

docs/wiki/contributing-to-wiki.md

Whitespace-only changes.

docs/wiki/core/.gitkeep

Whitespace-only changes.

docs/wiki/core/ChatHandler.md

Whitespace-only changes.

docs/wiki/core/Llama.md

Whitespace-only changes.

docs/wiki/core/LlamaChatFormat.md

Whitespace-only changes.

docs/wiki/core/LlamaCppBindings.md

Whitespace-only changes.

docs/wiki/core/MTMDCppBindings.md

Whitespace-only changes.

docs/wiki/development/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)