Skip to content

Commit b4cf7b4

Browse files
authored
clean docs by removing stuff that don't belong to the kernel client cli (#460)
1 parent 6581193 commit b4cf7b4

5 files changed

Lines changed: 2 additions & 217 deletions

File tree

docs/source/_toctree.yml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,18 +49,12 @@
4949
title: Kernels CLI
5050
title: API Reference
5151
- sections:
52-
- local: cli-init
53-
title: kernels init
54-
- local: cli-upload
55-
title: kernels upload
5652
- local: cli-benchmark
5753
title: kernels benchmark
5854
- local: cli-check
5955
title: kernels check
6056
- local: cli-versions
6157
title: kernels versions
62-
- local: cli-generate-readme
63-
title: kernels generate-readme
6458
- local: cli-lock
6559
title: kernels lock
6660
- local: cli-download

docs/source/cli-generate-readme.md

Lines changed: 0 additions & 61 deletions
This file was deleted.

docs/source/cli-init.md

Lines changed: 0 additions & 64 deletions
This file was deleted.

docs/source/cli-upload.md

Lines changed: 0 additions & 63 deletions
This file was deleted.

docs/source/cli.md

Lines changed: 2 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,39 +6,18 @@ The `kernels` CLI provides commands for managing compute kernels.
66

77
| Command | Description |
88
| ------------------------------------------------------- | -------------------------------------------------------- |
9-
| [init](cli-init.md) | Initialize a new kernel project from template |
109
| [upload](cli-upload.md) | Upload kernels to the Hub |
1110
| [benchmark](cli-benchmark.md) | Run benchmark results for a kernel |
1211
| [check](cli-check.md) | Check a kernel for compliance |
1312
| [versions](cli-versions.md) | Show kernel versions |
14-
| [generate-readme](cli-generate-readme.md) | Generate README snippets for a kernel's public functions |
1513
| [lock](cli-lock.md) | Lock kernel revisions |
1614
| [download](cli-download.md) | Download locked kernels |
17-
| [create-and-upload-card](cli-create-and-upload-card.md) | Create and upload a model card for a kernel |
1815
| [skills](cli-skills-add.md) | Add skills for AI coding assistants |
1916

2017
## Quick Start
2118

22-
### Create a new kernel project
23-
24-
```bash
25-
kernels init my-username/my-kernel
26-
cd my-kernel
27-
```
28-
29-
### Build and test locally
30-
31-
```bash
32-
cachix use huggingface
33-
nix run -L --max-jobs 1 --cores 8 .#build-and-copy
34-
uv run example.py
35-
```
36-
37-
### Upload to the Hub
38-
39-
```bash
40-
kernels upload ./build --repo-id my-username/my-kernel
41-
```
19+
For building and writing kernels, please refer [building kernels](./builder/build.md) and
20+
[writing kernels](./builder/writing-kernels.md).
4221

4322
### Use kernels in your project
4423

0 commit comments

Comments
 (0)