Skip to content

Link templates/ directory from README - #63

Open
dmchaledev wants to merge 1 commit into
mainfrom
claude/hopeful-knuth-3cl1tg
Open

Link templates/ directory from README#63
dmchaledev wants to merge 1 commit into
mainfrom
claude/hopeful-knuth-3cl1tg

Conversation

@dmchaledev

Copy link
Copy Markdown
Contributor

Summary

  • The templates/ directory contains 10 ready-to-use files (checklists, incident forms, a metrics dashboard, and training materials) but none of them were linked from README.md — anyone reading the repo's main entry point had no way to discover them.
  • Adds a new Templates & Tools section listing all 10 files grouped by folder (Checklists / Incident Forms / Metrics), each with a one-line description.
  • Also links the existing Training Resources bullets (Executive/Employee training) to their corresponding files in templates/training/, and links the Key Metrics bullet list to the KPI dashboard template.

Why

This repo's value is the full set of deliverables it ships, not just the 20 policy documents already indexed in the README. The templates/ content (audit checklists, incident report/notification forms, post-incident review form, KPI dashboard, training outlines) is directly usable during rollout, audits, and live incidents, but was effectively invisible outside of browsing the repo tree.

Verification

Confirmed all 10 new links resolve to existing files:

$ grep -oE '\]\(templates/[^)]+\)' README.md | sed 's/](//; s/)//' | sort -u | while read f; do [ -f "$f" ] && echo "OK: $f" || echo "MISSING: $f"; done
OK: templates/checklists/compliance_audit_checklist.md
OK: templates/checklists/implementation_checklist.md
OK: templates/checklists/incident_response_checklist.md
OK: templates/incident-forms/breach_notification_template.md
OK: templates/incident-forms/incident_report_template.md
OK: templates/incident-forms/post_incident_review_template.md
OK: templates/metrics/security_kpi_dashboard.md
OK: templates/training/employee_training_outline.md
OK: templates/training/executive_briefing_template.md
OK: templates/training/policy_acknowledgment_form.md

Test plan

  • Every added link verified to resolve to an existing file (see above)
  • Docs-only change (README.md), no code paths affected — existing CI (shellcheck, placeholder-coverage) is unaffected

Generated by Claude Code

The 10 files in templates/ (checklists, incident-forms, metrics,
training) were never referenced from README.md, making them
undiscoverable to anyone browsing the repo's main entry point.
Add a Templates & Tools section and link the existing Training
Resources bullets to their corresponding template files.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01CE2einH5APL6TeuXyQABt9
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants