From e481bcf70f887ea801539ff0c10e264b2f768215 Mon Sep 17 00:00:00 2001 From: Florian Wathling Date: Sat, 9 May 2026 16:41:16 +0200 Subject: [PATCH] Initial template setup --- .editorconfig | 9 ++++ .gitea/ISSUE_TEMPLATE/bug_report.md | 26 +++++++++ .gitea/ISSUE_TEMPLATE/feature_request.md | 22 ++++++++ .gitea/PULL_REQUEST_TEMPLATE.md | 22 ++++++++ .gitignore | 14 +++++ CODEOWNERS | 8 +++ LICENSE | 21 ++++++++ README.md | 68 ++++++++++++++++++++++++ decisions/ADR-0001-example.md | 18 +++++++ decisions/INDEX.md | 7 +++ runbooks/INDEX.md | 15 ++++++ specs/INDEX.md | 15 ++++++ 12 files changed, 245 insertions(+) create mode 100644 .editorconfig create mode 100644 .gitea/ISSUE_TEMPLATE/bug_report.md create mode 100644 .gitea/ISSUE_TEMPLATE/feature_request.md create mode 100644 .gitea/PULL_REQUEST_TEMPLATE.md create mode 100644 .gitignore create mode 100644 CODEOWNERS create mode 100644 LICENSE create mode 100644 README.md create mode 100644 decisions/ADR-0001-example.md create mode 100644 decisions/INDEX.md create mode 100644 runbooks/INDEX.md create mode 100644 specs/INDEX.md diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..cb9d312 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,9 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = false +indent_style = space +indent_size = 2 diff --git a/.gitea/ISSUE_TEMPLATE/bug_report.md b/.gitea/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..031c2d2 --- /dev/null +++ b/.gitea/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,26 @@ +--- +name: Bug Report +about: Something is broken or behaves unexpectedly +title: "[Bug] " +labels: ["bug"] +--- + +## What happened + + + +## Steps to reproduce + +1. +2. +3. + +## Environment + +- Version: +- OS: +- Anything else relevant: + +## Logs / Screenshots + + diff --git a/.gitea/ISSUE_TEMPLATE/feature_request.md b/.gitea/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..693fd4d --- /dev/null +++ b/.gitea/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,22 @@ +--- +name: Feature Request +about: Suggest an idea or improvement +title: "[Feature] " +labels: ["enhancement"] +--- + +## The problem + + + +## Proposed solution + + + +## Alternatives considered + + + +## Additional context + + diff --git a/.gitea/PULL_REQUEST_TEMPLATE.md b/.gitea/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..d00988a --- /dev/null +++ b/.gitea/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,22 @@ +## Summary + + + +- + +## Why + + + +## Testing + + + +- [ ] + +## Checklist + +- [ ] Code builds without warnings +- [ ] Tests pass (or N/A) +- [ ] Documentation updated (or N/A) +- [ ] No secrets or credentials committed diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9a58890 --- /dev/null +++ b/.gitignore @@ -0,0 +1,14 @@ +# OS +.DS_Store +Thumbs.db + +# Editors +.vscode/ +.idea/ +*.swp +*.swo + +# MkDocs / Docusaurus build output (uncomment if you add a generator) +# site/ +# build/ +# .docusaurus/ diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100644 index 0000000..e54a1af --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,8 @@ +# CODEOWNERS — automatic review-assignment for PRs. +# Syntax: +# +# More: https://docs.gitea.com/usage/code-owners +# +# Default owner for everything in the repo. +# Replace with the appropriate user/team for the new repo. +* @JonKazama-Hellion diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..765ff79 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Florian Wathling / Hellion Online Media + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..cb3ce97 --- /dev/null +++ b/README.md @@ -0,0 +1,68 @@ +# Docs Template + +A starting point for Markdown-only documentation repos on the [Hellion Forge](https://gitea.hellion-forge.cloud/). + +Use this for: + +- specs and design documents +- architecture decision records (ADRs) +- runbooks and post-mortems +- internal wikis + +This template is plain Markdown. If you want a rendered site, add MkDocs or Docusaurus on top — the structure here works as input for either. + +--- + +## How to use this template + +1. Click **"Use this template"** on the Forge. +2. Replace this README with one that describes your specific docs repo. +3. Drop content into the appropriate folders: + - `specs/` — feature specs, requirements, design proposals + - `decisions/` — ADRs (one file per decision, prefix `ADR-NNNN-`) + - `runbooks/` — operational guides, post-mortems, troubleshooting + +If a folder doesn't fit your use case, delete it. + +--- + +## Conventions + +- **One topic per file.** No mega-docs. Cross-link instead. +- **Filename = title slug.** Lowercase-kebab-case (`backup-strategy.md`, not `Backup Strategy.md`). +- **Index files** at folder roots (`specs/INDEX.md` etc.) link to all files in the folder. +- **Frontmatter** for status / dates if you use a generator that needs it. Plain Markdown otherwise. +- **No screenshots in the repo unless they're load-bearing** — link to external assets if possible. + +--- + +## ADR template + +Architecture Decision Records: one file per decision, append-only. + +```markdown +# ADR-0001: Title + +**Date:** 2026-05-09 +**Status:** accepted | superseded by ADR-NNNN | deprecated + +## Context + +What's the problem we're solving? Constraints, history. + +## Decision + +What did we decide. Concrete and short. + +## Consequences + +What changes because of this. Both positive and negative. +``` + +See `decisions/ADR-0001-example.md` for a worked example. + +--- + +## License + +MIT — see `LICENSE`. (For docs that include third-party content, override accordingly.) diff --git a/decisions/ADR-0001-example.md b/decisions/ADR-0001-example.md new file mode 100644 index 0000000..65036f4 --- /dev/null +++ b/decisions/ADR-0001-example.md @@ -0,0 +1,18 @@ +# ADR-0001: Example ADR + +**Date:** 2026-05-09 +**Status:** accepted + +## Context + +This is an example to show the ADR shape. Replace with your real first decision and renumber the file accordingly. + +## Decision + +Use the ADR pattern from Michael Nygard's article ("Documenting Architecture Decisions"): short, context-then-decision-then-consequences, one decision per file, append-only. + +## Consequences + +- Decisions are searchable and history-stable +- Old decisions stay readable even after they're superseded +- New contributors can read the ADR folder to understand "why is this the way it is" diff --git a/decisions/INDEX.md b/decisions/INDEX.md new file mode 100644 index 0000000..33b7476 --- /dev/null +++ b/decisions/INDEX.md @@ -0,0 +1,7 @@ +# Architecture Decision Records + +One file per decision, append-only. Status flows: `proposed` → `accepted` → optionally `superseded`/`deprecated`. + +| ID | Title | Status | Date | +|---|---|---|---| +| [ADR-0001](ADR-0001-example.md) | Example ADR | accepted | 2026-05-09 | diff --git a/runbooks/INDEX.md b/runbooks/INDEX.md new file mode 100644 index 0000000..7fcac11 --- /dev/null +++ b/runbooks/INDEX.md @@ -0,0 +1,15 @@ +# Runbooks + +Operational guides, troubleshooting, post-mortems. + +## Operations + +- _(add runbooks for routine operations here — backup, restore, deploy, rollback)_ + +## Troubleshooting + +- _(add diagnostic guides for common failure modes)_ + +## Post-mortems + +- _(one file per incident, prefix `YYYY-MM-DD-`)_ diff --git a/specs/INDEX.md b/specs/INDEX.md new file mode 100644 index 0000000..e2e77ad --- /dev/null +++ b/specs/INDEX.md @@ -0,0 +1,15 @@ +# Specs + +Feature specs, requirements, and design proposals. + +## Active + +- _(none yet)_ + +## Implemented + +- _(none yet)_ + +## Archived + +- _(none yet)_