Skip to content

Commit 9db4b76

Browse files
committed
docs: add frontmatter (title + description) to all doc pages
Required for the agent-friendly docs plugin to generate proper llms.txt entries and markdown endpoint headings.
1 parent 8f05029 commit 9db4b76

26 files changed

+130
-0
lines changed

docs/concepts/build-deploy-sync.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Build, Deploy, Sync
3+
description: Understand the three phases that move canister source code to a running, configured state on the Internet Computer.
4+
---
5+
16
# Build, Deploy, Sync
27

38
Canisters go through three distinct phases when moving from source code to running on the Internet Computer.

docs/concepts/environments.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Environments and Networks
3+
description: Learn how networks and environments relate to control where and how canisters are deployed.
4+
---
5+
16
# Environments and Networks
27

38
Understanding the relationship between networks and environments is key to effective deployment management.

docs/concepts/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Concepts
3+
description: Overview of core icp-cli concepts including project model, build lifecycle, environments, recipes, and canister discovery.
4+
---
5+
16
# Concepts
27

38
Understanding how icp-cli organizes and manages your project.

docs/concepts/project-model.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Project Model
3+
description: How icp-cli discovers, loads, and consolidates project configuration from icp.yaml and related manifest files.
4+
---
5+
16
# Project Model
27

38
This document explains how icp-cli discovers, loads, and consolidates your project configuration.

docs/concepts/recipes.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Recipes
3+
description: How recipes use Handlebars templates to generate reusable build and sync configurations, reducing canister boilerplate.
4+
---
5+
16
# Recipes
27

38
Recipes are templated build configurations that generate build and sync steps. They reduce boilerplate and encode best practices for common patterns.

docs/guides/containerized-networks.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Using Containerized Networks
3+
description: Run ICP test networks inside Docker containers for isolated, reproducible local development and CI/CD pipelines.
4+
---
5+
16
# Using Containerized Networks
27

38
Run ICP test networks in Docker containers for isolated, reproducible development environments.

docs/guides/creating-recipes.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Creating Recipes
3+
description: Author custom Handlebars-based recipe templates to encode build conventions and share them across projects.
4+
---
5+
16
# Creating Recipes
27

38
Recipes are reusable build templates that you can create to encode your team's build conventions or share them with the community.

docs/guides/creating-templates.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Creating Project Templates
3+
description: Create custom project templates for icp new using cargo-generate to scaffold new ICP projects.
4+
---
5+
16
# Creating Project Templates
27

38
Project templates let users scaffold new ICP projects with `icp new`. This guide covers creating custom templates for your team or the community.

docs/guides/deploying-to-mainnet.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Deploying to IC Mainnet
3+
description: Set up an identity, obtain cycles, and deploy canisters to the Internet Computer mainnet.
4+
---
5+
16
# Deploying to IC Mainnet
27

38
This guide walks through deploying your canisters to the Internet Computer mainnet.

docs/guides/deploying-to-specific-subnets.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
title: Deploying to Specific Subnets
3+
description: Target specific Internet Computer subnets for geographic, replication, or colocation requirements when deploying canisters.
4+
---
5+
16
# Deploying to Specific Subnets
27

38
The Internet Computer is composed of independent [subnets](https://learn.internetcomputer.org/hc/en-us/articles/34209955782420-Subnet-Creation) — each a blockchain that hosts canisters. By default, icp-cli selects a subnet automatically, but you can target specific subnets when needed.

0 commit comments

Comments
 (0)