Skip to content

This is the multi-page printable view of this section. .

Return to the regular view of this page.

Tutorial

Learn the project by making a small, complete change.

Follow an end-to-end task instead of reading isolated facts.

1 - Make Your First Change

Complete one small change and verify it locally.

This sample tutorial models a complete task: prepare, change, verify, and review.

Start from a known state

git status --short
git switch -c docs/first-change

Change one thing

Edit a visible string or a small configuration value. Keep the first task narrow enough that its result is obvious.

Verify

Run the project’s smallest relevant check, then open the changed surface and inspect it yourself.

2 - Add a Documentation Page

Create a page, place it in the sidebar, and link to it.

In OINK, the content tree is the documentation sidebar. A new Markdown file becomes a new page.

Create the file

---
title: New capability
description: What the capability does.
weight: 30
---

Explain the capability here.

Save it as content/docs/reference/new-capability.md.

Add translations

Create new-capability.zh.md and new-capability.fr.md beside it. Keep explicit heading IDs aligned across languages.

Preview

Run hugo server, open the new page, and use the language switcher to inspect every translation.