Skip to content

Commit 565e8a3

Browse files
authored
Improve documentation formatting and consistency (#633)
Small documentation improvements for better consistency: - Fixed capitalization (url → URL) in kernel README - Added bash syntax highlighting to code block in lab.md - Improved formatting consistency in ctr-example README (added colon + code fence) Co-authored-by: pickle-RickA <273219719+pickle-RickA@users.noreply.github.com>
1 parent d09a102 commit 565e8a3

3 files changed

Lines changed: 6 additions & 4 deletions

File tree

examples/ctr-example/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,10 @@ You should now see the `vmlinux` image in examples/ctr-example
2222

2323
### 2. Build/Run ctr-example
2424

25-
From examples/ctr-example run
26-
`make all`
25+
From examples/ctr-example run:
26+
```bash
27+
make all
28+
```
2729

2830
> [!WARNING]
2931
> If you get the following error, try building from the default macOS terminal:

examples/ctr-example/lab.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This'll install your kernel.
1414

1515
After this start your first container. On first launch, this'll install another artifact for our guest init process:
1616

17-
```
17+
```bash
1818
container run alpine uname
1919
```
2020

kernel/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This directory includes an optimized kernel configuration to produce a fast and lightweight kernel for container use.
44

55
- `config-arm64` includes the kernel `CONFIG_` options.
6-
- `Makefile` includes the kernel version and source package url.
6+
- `Makefile` includes the kernel version and source package URL.
77
- `build.sh` scripts the kernel build process.
88
- `image/` includes the configuration for an image with build tooling.
99

0 commit comments

Comments
 (0)