From 24fb35318eebda201d7134290b0c4ff86b508f86 Mon Sep 17 00:00:00 2001 From: Marco Walz Date: Wed, 18 Mar 2026 15:46:27 +0100 Subject: [PATCH] docs: consolidate list item separators to em dashes Closes #446 --- docs/README.md | 15 ++++++++------- docs/concepts/project-model.md | 8 ++++---- docs/guides/containerized-networks.md | 12 ++++++------ docs/reference/configuration.md | 8 ++++---- 4 files changed, 22 insertions(+), 21 deletions(-) diff --git a/docs/README.md b/docs/README.md index 7838d217..1dae0057 100644 --- a/docs/README.md +++ b/docs/README.md @@ -32,18 +32,19 @@ Starlight renders the `title` as the page's H1 heading, so do **not** add a sepa ### Best Practices -- Use standard Markdown - keep it simple and GitHub-friendly +- Use standard Markdown — keep it simple and GitHub-friendly - Always include `title` and `description` in frontmatter - Use relative links with `.md` extensions: `[text](./other-doc.md)` (works on GitHub; a rehype plugin strips `.md` at build time) - Use `.md` files (not `.mdx`) for better GitHub rendering - Code blocks with language: ` ```bash ` +- Use em dashes (`—`) to separate list item subjects from descriptions: `- **Term** — Description` ## Generated Documentation Some docs are auto-generated from code: -- **`reference/cli.md`** - Generated by `scripts/generate-cli-docs.sh` from CLI command definitions -- **`schemas/*.json`** - Generated by `scripts/generate-config-schemas.sh` from Rust types +- **`reference/cli.md`** — Generated by `scripts/generate-cli-docs.sh` from CLI command definitions +- **`schemas/*.json`** — Generated by `scripts/generate-config-schemas.sh` from Rust types Run these scripts when command-line options or config types change. @@ -95,9 +96,9 @@ The documentation website is automatically built and deployed to GitHub Pages: ## Directory Guidelines -- **`guides/`** - Task-oriented, step-by-step instructions -- **`concepts/`** - Understanding-oriented explanations -- **`reference/`** - Information-oriented specifications -- **`migration/`** - Version or tool migration guides +- **`guides/`** — Task-oriented, step-by-step instructions +- **`concepts/`** — Understanding-oriented explanations +- **`reference/`** — Information-oriented specifications +- **`migration/`** — Version or tool migration guides This follows the [Diátaxis](https://diataxis.fr/) documentation framework. diff --git a/docs/concepts/project-model.md b/docs/concepts/project-model.md index 98e9f1c7..d5f1f89c 100644 --- a/docs/concepts/project-model.md +++ b/docs/concepts/project-model.md @@ -59,8 +59,8 @@ Networks can be defined in three ways: ### Implicit networks There are two implicit networks defined: -- `local` - is a local managed network -- `ic` - is the IC mainnet (connected network) +- `local` — is a local managed network +- `ic` — is the IC mainnet (connected network) Their configuration is equivalent to: @@ -109,8 +109,8 @@ Environments can be defined in three ways: ### Implicit Environments There are two implicit environments: -- `local` - uses the local managed network -- `ic` - uses the IC mainnet +- `local` — uses the local managed network +- `ic` — uses the IC mainnet They are defined like this: diff --git a/docs/guides/containerized-networks.md b/docs/guides/containerized-networks.md index b440d881..cf9ea164 100644 --- a/docs/guides/containerized-networks.md +++ b/docs/guides/containerized-networks.md @@ -271,9 +271,9 @@ The anonymous principal must have sufficient ICP balance to fund all identities ### Required System Canisters The network must include these system canisters: -- **ICP ledger** - For ICP token transfers during seeding -- **Cycles ledger** - For cycles management -- **Cycles minting canister (CMC)** - For converting ICP to cycles +- **ICP ledger** — For ICP token transfers during seeding +- **Cycles ledger** — For cycles management +- **Cycles minting canister (CMC)** — For converting ICP to cycles ## Troubleshooting @@ -456,9 +456,9 @@ ENTRYPOINT ["/app/start-network.sh"] Your custom network must include the system canisters and pre-funded accounts described in [Image Contract](#image-contract). In summary: **Required system canisters:** -- **ICP ledger canister** (`ryjl3-tyaaa-aaaaa-aaaba-cai`) - For ICP token transfers -- **Cycles ledger canister** (`um5iw-rqaaa-aaaaq-qaaba-cai`) - For cycles management -- **Cycles minting canister** (`rkp4c-7iaaa-aaaaa-aaaca-cai`) - For converting ICP to cycles +- **ICP ledger canister** (`ryjl3-tyaaa-aaaaa-aaaba-cai`) — For ICP token transfers +- **Cycles ledger canister** (`um5iw-rqaaa-aaaaq-qaaba-cai`) — For cycles management +- **Cycles minting canister** (`rkp4c-7iaaa-aaaaa-aaaca-cai`) — For converting ICP to cycles **Pre-funded anonymous principal:** diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md index c0bdb630..4e934b2d 100644 --- a/docs/reference/configuration.md +++ b/docs/reference/configuration.md @@ -478,10 +478,10 @@ environments: ## Schema JSON schemas for editor integration are available in [docs/schemas/](https://github.com/dfinity/icp-cli/tree/main/docs/schemas): -- [`icp-yaml-schema.json`](https://raw.githubusercontent.com/dfinity/icp-cli/main/docs/schemas/icp-yaml-schema.json) - Main project configuration -- [`canister-yaml-schema.json`](https://raw.githubusercontent.com/dfinity/icp-cli/main/docs/schemas/canister-yaml-schema.json) - Canister configuration -- [`network-yaml-schema.json`](https://raw.githubusercontent.com/dfinity/icp-cli/main/docs/schemas/network-yaml-schema.json) - Network configuration -- [`environment-yaml-schema.json`](https://raw.githubusercontent.com/dfinity/icp-cli/main/docs/schemas/environment-yaml-schema.json) - Environment configuration +- [`icp-yaml-schema.json`](https://raw.githubusercontent.com/dfinity/icp-cli/main/docs/schemas/icp-yaml-schema.json) — Main project configuration +- [`canister-yaml-schema.json`](https://raw.githubusercontent.com/dfinity/icp-cli/main/docs/schemas/canister-yaml-schema.json) — Canister configuration +- [`network-yaml-schema.json`](https://raw.githubusercontent.com/dfinity/icp-cli/main/docs/schemas/network-yaml-schema.json) — Network configuration +- [`environment-yaml-schema.json`](https://raw.githubusercontent.com/dfinity/icp-cli/main/docs/schemas/environment-yaml-schema.json) — Environment configuration Configure your editor to use them for autocomplete and validation: