Page Templates

Use these templates as the default starting point for new authored pages. They reflect the current architecture contracts and layout behavior.

Shared rules

• Use filename locale suffixes (*.en.md, *.ja.md).
• Keep one translationKey across translations.
• Use aliases for legacy URL migration, not duplicate pages.
• Article pages automatically get the shared assist bar (TTS + Ask AI + share controls) when content is readable and not hidden by access policy.

Docs template (reference / overview)

---
title: "Soracom Example Service"
description: "What this service does and when to use it."
translationKey: soracom-example-service
section: "Connectivity"
subsection: "Cellular"
order: 10
access: public
gateVisibility: hidden
gatePolicy: signed-in
requiredEntitlements: []
disableSearchEngineIndex: false
disableSearchIndex: false
disableFeedback: false
freeTier: true
tier: core
status: ga
gettingStartedGuide: quick-start-example
faqItems:
  - question: "When should I use this service?"
    answer: "Use it when you need ..."
---

## What it is

Short overview.

## When to use it

Decision guidance.

## Key settings

Configuration details.

## Related docs

- Link 1
- Link 2

Guides template (task / workflow)

---
title: "Build X with Soracom"
description: "Outcome-driven guide summary."
translationKey: guide-build-x
publishDate: 2026-03-16
difficulty: beginner
categories: ["getting-started"]
products: ["soracom-air", "soracom-harvest"]
providers: ["aws"]
designPhases: ["plan", "prototype"]
freeTier: true
connectivity: arc
estimatedCost: "~$0 while within free tier"
access: public
disableSearchEngineIndex: false
disableSearchIndex: false
disableFeedback: false
howToSteps:
  - name: "Prepare your account"
    text: "Create account and collect credentials."
---

## Prerequisites

- Requirement 1
- Requirement 2

## Step 1: Prepare

Action + verification.

## Step 2: Configure

Action + verification.

## Troubleshooting

Common errors and fixes.

## Next steps

- Link 1
- Link 2

Learn template (concept / path node)

---
title: "How Soracom Example Works"
description: "Concept summary and scope."
translationKey: learn-how-example-works
publishDate: 2026-03-16
category: Concepts
order: 20
tags: ["connectivity", "security"]
access: public
disableSearchEngineIndex: false
disableSearchIndex: false
disableFeedback: false
faqItems:
  - question: "Why does this matter?"
    answer: "Because ..."
---

## Key concept 1

Explanation.

## Key concept 2

Explanation.

## Common pitfalls

- Pitfall 1
- Pitfall 2

## Next steps

- Link 1
- Link 2

Access patterns

Use this as a quick policy guide:

• public: visible and indexable by default
• gated + gateVisibility: visible: appears in nav, page body/sections can require sign-in
• private: hidden from nav/search/sitemap and treated as non-indexable

Validation checklist

• Frontmatter validates against src/content.config.ts
• Slug/locale behavior matches src/content/system/routeSlugs.ts
• Access behavior aligns with src/content/system/access.ts
• Related links resolve in both EN and JA route families