ReachableCEO
ca8905fa4e
Some checks are pending
CI / checks (pull_request) Waiting to run
- Move docs to docs/; keep areas for prompts only - Relocate Makefile to scripts/Makefile; update docs to use it - Move ci.Dockerfile to docker/ci.Dockerfile; update compose - Move commitlint config to .config and update hook - Remove root AGENTS.md (use area AGENTS.md)
9 lines
480 B
Markdown
9 lines
480 B
Markdown
Documentation Style Guide
|
|
|
|
- When referencing another Markdown file in this repo, use a relative link so it is clickable in Gitea. Example: [docs/git-workflow.md](git-workflow.md).
|
|
- Keep titles concise and descriptive; use sentence case unless a proper noun.
|
|
- Prefer short bullets (one point per line). Merge related points.
|
|
- Use backticks for commands, file paths, env vars, and code identifiers.
|
|
- Make documents actionable: lead with outcomes, then steps, then background.
|
|
|