Skip to content

Commit 3bcd801

Browse files
committed
docs(wiki): link installation guide from index
Promote the completed installation guide into the wiki entry point so new users can find build and backend setup instructions before reading API-specific documentation. - Add a Getting Started section that links to install.md. - Move installation to the top of the recommended reading order. - Mark install.md as an available page. - Remove installation from the planned documentation areas. Signed-off-by: JamePeng <jame_peng@sina.com>
1 parent a29c754 commit 3bcd801

1 file changed

Lines changed: 22 additions & 10 deletions

File tree

docs/wiki/index.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,16 @@ The documentation is maintained with the help of LLMs, but the source of truth i
1010

1111
## Quick Navigation
1212

13+
### Getting Started
14+
15+
Start here if you are installing or rebuilding `llama-cpp-python`.
16+
17+
| Page | Description |
18+
|---|---|
19+
| [install\|Installation] | Source installation guide covering Python setup, CMake options, llama.cpp backend selection, hardware acceleration, rebuilds, and verification. |
20+
21+
---
22+
1323
### Core API
1424

1525
Start here if you are using `llama-cpp-python` directly.
@@ -42,7 +52,7 @@ This section contains maintainer-facing development notes, workflows, and LLM-as
4252

4353
| Page | Description |
4454
|---|---|
45-
| [[development/Git Commit Generation Agent]] | Helper workflow for generating clear, structured, and source-aware Git commit messages. |
55+
| [development/Git Commit Generation Agent] | Helper workflow for generating clear, structured, and source-aware Git commit messages. |
4656

4757
---
4858

@@ -61,13 +71,14 @@ These pages define how the wiki should be written, updated, and reviewed.
6171

6272
If you are new to this wiki, read the pages in this order:
6373

64-
1. [[core/Llama|Llama](https://github.com/JamePeng/llama-cpp-python/blob/main/docs/wiki/core/Llama.md)]
65-
2. [[modules/LlamaCache|Llama Cache](https://github.com/JamePeng/llama-cpp-python/blob/main/docs/wiki/modules/LlamaCache.md)]
66-
3. [[modules/LlamaEmbedding|Llama Embedding](https://github.com/JamePeng/llama-cpp-python/blob/main/docs/wiki/modules/LlamaEmbedding.md)]
67-
4. [[modules/LlamaGrammar|Llama Grammar](https://github.com/JamePeng/llama-cpp-python/blob/main/docs/wiki/modules/LlamaGrammar.md)]
68-
5. [[modules/LlamaSpeculative|Llama Speculative Decoding](https://github.com/JamePeng/llama-cpp-python/blob/main/docs/wiki/modules/LlamaSpeculative.md)]
69-
6. [[modules/Logger\|Logger](https://github.com/JamePeng/llama-cpp-python/blob/main/docs/wiki/modules/Logger.md)]
70-
7. [[development/Git Commit Generation Agent](https://github.com/JamePeng/llama-cpp-python/blob/main/docs/wiki/development/git-commit-generation-agent.md)]
74+
1. [[install|Installation](https://github.com/JamePeng/llama-cpp-python/blob/main/docs/wiki/install.md)]
75+
2. [[core/Llama|Llama](https://github.com/JamePeng/llama-cpp-python/blob/main/docs/wiki/core/Llama.md)]
76+
3. [[modules/LlamaCache|Llama Cache](https://github.com/JamePeng/llama-cpp-python/blob/main/docs/wiki/modules/LlamaCache.md)]
77+
4. [[modules/LlamaEmbedding|Llama Embedding](https://github.com/JamePeng/llama-cpp-python/blob/main/docs/wiki/modules/LlamaEmbedding.md)]
78+
5. [[modules/LlamaGrammar|Llama Grammar](https://github.com/JamePeng/llama-cpp-python/blob/main/docs/wiki/modules/LlamaGrammar.md)]
79+
6. [[modules/LlamaSpeculative|Llama Speculative Decoding](https://github.com/JamePeng/llama-cpp-python/blob/main/docs/wiki/modules/LlamaSpeculative.md)]
80+
7. [[modules/Logger\|Logger](https://github.com/JamePeng/llama-cpp-python/blob/main/docs/wiki/modules/Logger.md)]
81+
8. [[development/Git Commit Generation Agent](https://github.com/JamePeng/llama-cpp-python/blob/main/docs/wiki/development/git-commit-generation-agent.md)]
7182

7283
If you are contributing documentation, start with:
7384
1. [[SCHEMA|Wiki Schema](https://github.com/JamePeng/llama-cpp-python/blob/main/docs/wiki/SCHEMA.md)]
@@ -81,6 +92,7 @@ The wiki is still being expanded.
8192

8293
Currently available pages:
8394

95+
- `install.md`
8496
- `core/Llama.md`
8597
- `modules/LlamaCache.md`
8698
- `modules/LlamaEmbedding.md`
@@ -99,7 +111,6 @@ Some planned pages may already exist as empty placeholder files. Empty pages are
99111

100112
Future documentation may cover:
101113

102-
- Installation and build options
103114
- Chat formats and chat handlers
104115
- Low-level ctypes bindings
105116
- Multimodal APIs
@@ -126,5 +137,6 @@ This wiki follows a few core rules:
126137
## Project Links
127138

128139
- GitHub: [llama-cpp-python](https://github.com/JamePeng/llama-cpp-python)
140+
- Installation guide: [install](https://github.com/JamePeng/llama-cpp-python/blob/main/docs/wiki/install.md)
129141
- Wiki schema: [SCHEMA](https://github.com/JamePeng/llama-cpp-python/blob/main/docs/wiki/SCHEMA.md)
130-
- Contribution guide: [contributing-to-wiki](https://github.com/JamePeng/llama-cpp-python/blob/main/docs/wiki/contributing-to-wiki.md)
142+
- Contribution guide: [contributing-to-wiki](https://github.com/JamePeng/llama-cpp-python/blob/main/docs/wiki/contributing-to-wiki.md)

0 commit comments

Comments
 (0)