From e27a8e55e66adb0151ef92521b32a9f47438b23f Mon Sep 17 00:00:00 2001 From: pickle-RickA <193382566+pickle-RickA@users.noreply.github.com> Date: Fri, 3 Apr 2026 01:05:51 +0300 Subject: [PATCH] improve documentation formatting and consistency - Fix capitalization: url -> URL in kernel README - Add bash language tag to code block in lab.md - Improve formatting consistency in ctr-example README --- examples/ctr-example/README.md | 6 ++++-- examples/ctr-example/lab.md | 2 +- kernel/README.md | 2 +- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/examples/ctr-example/README.md b/examples/ctr-example/README.md index 9b339fc5..1563eb0a 100644 --- a/examples/ctr-example/README.md +++ b/examples/ctr-example/README.md @@ -22,8 +22,10 @@ You should now see the `vmlinux` image in examples/ctr-example ### 2. Build/Run ctr-example -From examples/ctr-example run -`make all` +From examples/ctr-example run: +```bash +make all +``` > [!WARNING] > If you get the following error, try building from the default macOS terminal: diff --git a/examples/ctr-example/lab.md b/examples/ctr-example/lab.md index dd1bbbdf..d51630c0 100644 --- a/examples/ctr-example/lab.md +++ b/examples/ctr-example/lab.md @@ -14,7 +14,7 @@ This'll install your kernel. After this start your first container. On first launch, this'll install another artifact for our guest init process: -``` +```bash container run alpine uname ``` diff --git a/kernel/README.md b/kernel/README.md index 2d8b07c1..bba12c08 100644 --- a/kernel/README.md +++ b/kernel/README.md @@ -3,7 +3,7 @@ This directory includes an optimized kernel configuration to produce a fast and lightweight kernel for container use. - `config-arm64` includes the kernel `CONFIG_` options. -- `Makefile` includes the kernel version and source package url. +- `Makefile` includes the kernel version and source package URL. - `build.sh` scripts the kernel build process. - `image/` includes the configuration for an image with build tooling.