chore(repo): clean root; move docs; keep areas for prompts
Some checks failed
CI / checks (push) Has been cancelled
Some checks failed
CI / checks (push) Has been cancelled
This commit is contained in:
8
docs/docs-style.md
Normal file
8
docs/docs-style.md
Normal file
@@ -0,0 +1,8 @@
|
||||
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.
|
||||
|
Reference in New Issue
Block a user