KNEL/LLMScaffolding
1
0
Fork 0
Code Issues Pull Requests 1 Actions 11 Packages Projects Releases 1 Wiki Activity
Files
main
LLMScaffolding/docs/docs-style.md
ReachableCEO a00b6a8782 chore(repo): clean root and move docs 
- 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)
2025-09-10 18:00:50 -05:00

480 B
Raw Permalink Blame History

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.