From 95c55b5f288fe3f5d2ec07c986467f8abbb0c2da Mon Sep 17 00:00:00 2001 From: asanvaq Date: Thu, 11 Jun 2026 10:41:40 +0200 Subject: [PATCH] feat: add metadata descriptions to all pages. --- docs/explanation/index.md | 6 ++++++ docs/explanation/mode-of-operation.md | 6 ++++++ docs/explanation/slice-design-approaches.md | 6 ++++++ docs/explanation/slices.md | 6 ++++++ docs/how-to/index.md | 6 ++++++ docs/how-to/install-chisel.md | 6 ++++++ docs/how-to/install-pro-package-slices.md | 6 ++++++ docs/how-to/slice-a-package.md | 6 ++++++ docs/how-to/use-chisel-in-dockerfile.md | 6 ++++++ docs/index.md | 6 ++++++ docs/reference/chisel-releases/chisel.yaml.md | 6 ++++++ docs/reference/chisel-releases/index.md | 6 ++++++ docs/reference/chisel-releases/slice-definitions.md | 6 ++++++ docs/reference/cmd/cut.md | 6 ++++++ docs/reference/cmd/find.md | 6 ++++++ docs/reference/cmd/help.md | 6 ++++++ docs/reference/cmd/index.md | 6 ++++++ docs/reference/cmd/info.md | 6 ++++++ docs/reference/cmd/version.md | 6 ++++++ docs/reference/index.md | 6 ++++++ docs/reference/manifest.md | 6 ++++++ docs/reference/security.md | 6 ++++++ docs/tutorial/getting-started.md | 6 ++++++ 23 files changed, 138 insertions(+) diff --git a/docs/explanation/index.md b/docs/explanation/index.md index 756bebb..66313bc 100644 --- a/docs/explanation/index.md +++ b/docs/explanation/index.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "The explanatory documentation for Chisel. These explanations aid in understanding the core concepts of Chisel." +--- + # Explanation This section of the documentation covers the core concepts of Chisel. diff --git a/docs/explanation/mode-of-operation.md b/docs/explanation/mode-of-operation.md index 90e39b6..a06299a 100644 --- a/docs/explanation/mode-of-operation.md +++ b/docs/explanation/mode-of-operation.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Explanation of how Chisel works: reading chisel-releases, fetching packages from Ubuntu archives, and extracting selected files into a root file system." +--- + (chisel_mo_explanation)= # How Chisel works diff --git a/docs/explanation/slice-design-approaches.md b/docs/explanation/slice-design-approaches.md index f488b71..a3561eb 100644 --- a/docs/explanation/slice-design-approaches.md +++ b/docs/explanation/slice-design-approaches.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Explanation of the two slice design approaches in Chisel: grouping by content type (bins, libs) or by functionality (minimal, core, standard)." +--- + (slice_design_approaches)= # Slice design approaches diff --git a/docs/explanation/slices.md b/docs/explanation/slices.md index 99aabde..2410998 100644 --- a/docs/explanation/slices.md +++ b/docs/explanation/slices.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Explanation of package slices in Chisel: subsets of Debian packages with their own files and dependencies, used to build minimal Ubuntu root file systems." +--- + (slices_explanation)= # Slices diff --git a/docs/how-to/index.md b/docs/how-to/index.md index b6e59dc..7280a56 100644 --- a/docs/how-to/index.md +++ b/docs/how-to/index.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "The practical, goal-oriented documentation for Chisel. These guides provide directions for completing tasks and solving problems with Chisel." +--- + (how_to_guides)= # How-to guides diff --git a/docs/how-to/install-chisel.md b/docs/how-to/install-chisel.md index 68b44ec..06b8aec 100644 --- a/docs/how-to/install-chisel.md +++ b/docs/how-to/install-chisel.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "How to install Chisel on Linux by downloading the pre-built binary, building from source, or installing the Snap package." +--- + (install_chisel)= # How to install Chisel diff --git a/docs/how-to/install-pro-package-slices.md b/docs/how-to/install-pro-package-slices.md index 902399b..08d5bde 100644 --- a/docs/how-to/install-pro-package-slices.md +++ b/docs/how-to/install-pro-package-slices.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "How to configure Chisel to fetch and install Ubuntu Pro package slices, including archive definitions and credentials setup." +--- + (install_pro_packages)= # Install Ubuntu Pro package slices diff --git a/docs/how-to/slice-a-package.md b/docs/how-to/slice-a-package.md index 35ba7c2..f524d85 100644 --- a/docs/how-to/slice-a-package.md +++ b/docs/how-to/slice-a-package.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "How to slice an Ubuntu package with Chisel by inspecting its contents, designing slices, and writing and testing a slice definitions file." +--- + (slice_package)= # Slice a package diff --git a/docs/how-to/use-chisel-in-dockerfile.md b/docs/how-to/use-chisel-in-dockerfile.md index b4de330..072db04 100644 --- a/docs/how-to/use-chisel-in-dockerfile.md +++ b/docs/how-to/use-chisel-in-dockerfile.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "How to use Chisel in a multi-stage Dockerfile to build a minimal, distroless-like container image from Ubuntu package slices." +--- + (use_chisel_dockerfile)= # Use Chisel in a Dockerfile diff --git a/docs/index.md b/docs/index.md index 524144a..85fd9d4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Chisel is a tool for creating minimal Ubuntu root file systems by selecting and installing only the necessary package slices." +--- + # Chisel **Chisel** is a developer tool for extracting highly customized and specialized [package slices](slices_explanation) of Ubuntu packages to create diff --git a/docs/reference/chisel-releases/chisel.yaml.md b/docs/reference/chisel-releases/chisel.yaml.md index d0cbd88..842e62c 100644 --- a/docs/reference/chisel-releases/chisel.yaml.md +++ b/docs/reference/chisel-releases/chisel.yaml.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Reference for the chisel.yaml configuration file, covering format versions, archive definitions, maintenance, public keys, and Ubuntu Pro settings." +--- + (chisel_yaml_ref)= # chisel.yaml diff --git a/docs/reference/chisel-releases/index.md b/docs/reference/chisel-releases/index.md index e3aeae0..d31b9c7 100644 --- a/docs/reference/chisel-releases/index.md +++ b/docs/reference/chisel-releases/index.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Reference for chisel-releases, the versioned directory of slice definitions files and chisel.yaml that Chisel uses to identify and fetch package slices." +--- + (chisel-releases_ref)= # chisel-releases diff --git a/docs/reference/chisel-releases/slice-definitions.md b/docs/reference/chisel-releases/slice-definitions.md index 811cb13..b7d5adf 100644 --- a/docs/reference/chisel-releases/slice-definitions.md +++ b/docs/reference/chisel-releases/slice-definitions.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Reference for the slice definitions file format for Ubuntu package slices, covering the location, format specifications and examples." +--- + (slice_definitions_ref)= # Slice definitions diff --git a/docs/reference/cmd/cut.md b/docs/reference/cmd/cut.md index 0e13fac..4e6a256 100644 --- a/docs/reference/cmd/cut.md +++ b/docs/reference/cmd/cut.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Reference for the Chisel cut command, which slices Ubuntu packages and installs selected package slices into a root file system directory." +--- + (cut_command_reference)= # cut command diff --git a/docs/reference/cmd/find.md b/docs/reference/cmd/find.md index b069934..d3b9206 100644 --- a/docs/reference/cmd/find.md +++ b/docs/reference/cmd/find.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Reference for the Chisel find command, which searches chisel-releases for available package slices matching a name pattern." +--- + (find_command_reference)= # find command diff --git a/docs/reference/cmd/help.md b/docs/reference/cmd/help.md index 189b198..3864954 100644 --- a/docs/reference/cmd/help.md +++ b/docs/reference/cmd/help.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Reference for the Chisel help command, which displays usage information and a summary of available subcommands." +--- + (help_command_reference)= # help command diff --git a/docs/reference/cmd/index.md b/docs/reference/cmd/index.md index 0daafa6..4d5af6b 100644 --- a/docs/reference/cmd/index.md +++ b/docs/reference/cmd/index.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Reference for the Chisel command-line interface, covering the cut, find, info, version, and help subcommands with their options and usage." +--- + (command_reference)= # CLI Commands diff --git a/docs/reference/cmd/info.md b/docs/reference/cmd/info.md index 77bbe50..92ead49 100644 --- a/docs/reference/cmd/info.md +++ b/docs/reference/cmd/info.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Reference for the Chisel info command, which displays slice definitions for given package or slice names from a chisel-release in YAML format." +--- + (info_command_reference)= # info command diff --git a/docs/reference/cmd/version.md b/docs/reference/cmd/version.md index 06a34f4..30c12f4 100644 --- a/docs/reference/cmd/version.md +++ b/docs/reference/cmd/version.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Reference for the Chisel version command, which prints the currently installed Chisel version string to standard output and exits." +--- + (version_command_reference)= # version command diff --git a/docs/reference/index.md b/docs/reference/index.md index 7731233..bd179b7 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "The reference documentation for Chisel. These references describe the structure and function of the individual components in Chisel." +--- + # Reference This section provides concise references on available commands, package slices, and security. diff --git a/docs/reference/manifest.md b/docs/reference/manifest.md index b5308d2..37a0ffc 100644 --- a/docs/reference/manifest.md +++ b/docs/reference/manifest.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Reference for the Chisel manifest: a ZSTD-compressed jsonwall file listing metadata about installed packages, slices, and files in a root file system." +--- + (chisel_manifest_ref)= # Chisel Manifest diff --git a/docs/reference/security.md b/docs/reference/security.md index d7fb59a..ebd56ba 100644 --- a/docs/reference/security.md +++ b/docs/reference/security.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Reference for Chisel's cryptographic verification process, including GPG signature checks and checksum validation." +--- + (chisel_security_ref)= # Chisel Cryptographic Documentation diff --git a/docs/tutorial/getting-started.md b/docs/tutorial/getting-started.md index 17d0fef..e037762 100644 --- a/docs/tutorial/getting-started.md +++ b/docs/tutorial/getting-started.md @@ -1,3 +1,9 @@ +--- +myst: + html_meta: + description: "Learn how to create a chiseled Ubuntu root file system from scratch, from installing Chisel to slicing Ubuntu packages in 15 minutes." +--- + (chisel_helloworld_tutorial)= # Getting started with Chisel