Table of Contents

📖 Documentation¶

Tutorials → learning: ROADMAP + journal
How-to guides: project SPECs , scripts
Reference: cheatsheets , interview
Explanation: these docs + NOTES + ADRs

Long-form, canonical docs for the repository (versioned with the code).

Doc	What it covers
RESEARCH.md	Phase 1 — best-practices research that justifies the repo's design
STANDARDS.md	Folder/file naming, markdown, diagram, and documentation standards
GITHUB_WORKFLOW.md	Branching, commits, project board, labels, milestones, releases
PORTFOLIO.md	How the work becomes hireable signal; résumé bullets per project
BEST_PRACTICES_CHECKLIST.md	Production Go checklist to grade every service
CONTINUOUS_IMPROVEMENT.md	Feedback loops and how the repo keeps improving
PUBLISHING.md	Publish the content as a public docs site (repo stays private)
adr/	Architecture Decision Records

Doc philosophy (Diátaxis)¶