# Docs Sync

> Use when editing README, README.zh-tw, docs, AGENTS.md, or keeping human docs and Codex agent instructions synchronized.

- Skill: `tomevault-io/docs-sync-6` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add tomevault-io/docs-sync-6`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tomevault-io/docs-sync-6/raw
- Safety review: pending (external: skill-scanner PASS, skillspector PASS)
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Product & Planning
- Author: tomevault-io (https://skillmd.com/u/tomevault-io)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/tomevault-io/docs-sync-6

---


# Documentation sync

## README role

`README.md` is for humans.

Keep it:

- clear
- simple
- short
- easy to scan
- focused on purpose, flow, supported metrics, quick start, and links

Avoid putting long references in README.

Move details to `docs/`.

## README.zh-tw role

`README.zh-tw.md` should track the same structure as `README.md`,
but it does not need to be a word-for-word translation.

Use Traditional Chinese with common technical terms left in English when clearer.

## AGENTS.md role

`AGENTS.md` is a short Codex routing portal.

Do not put all detailed rules in AGENTS.md.

Point to `.agents/skills/*/SKILL.md` instead.

## Docs role

Use `docs/` for detailed human documentation:

- install-systemd.md
- configuration.md
- publishers.md
- mqtt-topics.md
- home-assistant.md
- troubleshooting.md
- development.md

## Checklist

Before finishing documentation changes:

- README remains short.
- README and README.zh-tw have similar structure.
- Detailed references live in docs.
- AGENTS.md remains a portal, not a full manual.
- Relevant skill files are updated if agent behavior changed.

---
> Source: [deepkh/homelab_ha_discovery](https://github.com/deepkh/homelab_ha_discovery) — distributed by [TomeVault](https://tomevault.io).
<!-- tomevault:4.0:skill_md:2026-06-16 -->