Files
LLMScaffolding/docs/docs-style.md
ReachableCEO cd9653c66a
Some checks failed
CI / checks (push) Has been cancelled
chore(repo): clean root; move docs; keep areas for prompts
2025-09-11 07:05:00 -05:00

480 B

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.
  • 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.