docs(style): enforce clickable links for Markdown references

- Add COMMON/docs-style.md with linking rule
- Convert plain Markdown file references to relative links across docs
This commit is contained in:
2025-09-10 17:43:37 -05:00
parent 59e104a57c
commit 2a7d270062
12 changed files with 31 additions and 98 deletions

View File

@@ -5,9 +5,9 @@ Purpose
- Opinionated but adaptable; intended as a base layer.
Contents (initial)
- Git workflow (branching, merges, commit style)
- CI/bootstrap parity guidance
- Git workflow: [COMMON/git-workflow.md](git-workflow.md)
- CI/bootstrap parity: [COMMON/bootstrap-cicd.md](bootstrap-cicd.md)
- Documentation style: [COMMON/docs-style.md](docs-style.md)
Notes
- Keep content generic and reusable; project-specific overrides should live in the target repo.

8
COMMON/docs-style.md Normal file
View 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: [COMMON/git-workflow.md](COMMON/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.