Skip to content

Latest commit

Β 

History

History
54 lines (42 loc) Β· 2.12 KB

File metadata and controls

54 lines (42 loc) Β· 2.12 KB

Documentation

This directory contains all project documentation.

πŸ“š Available Documentation

Testing & Quality

CI/CD

Architecture & Development

Other

πŸ”— Quick Links

πŸ“– Documentation Structure

docs/
β”œβ”€β”€ README.md                    # This file
β”œβ”€β”€ TESTING.md                   # Testing guide
β”œβ”€β”€ TEST_SUMMARY.md              # Coverage statistics
β”œβ”€β”€ CI_CD.md                     # CI/CD documentation
β”œβ”€β”€ README_TESTING_CI.md        # Testing & CI quick start
β”œβ”€β”€ USER_SERVICE_README.md       # User Service docs
β”œβ”€β”€ ARCHITECTURE_TESTING.md      # Architecture details
β”œβ”€β”€ CI_FIXES.md                  # CI fixes
β”œβ”€β”€ GOFMT_FIX.md                 # gofmt fixes
β”œβ”€β”€ TESTIFY_FIX.md               # Testify fixes
β”œβ”€β”€ LINTER_FIXES.md              # Linter fixes
└── COMMIT_MESSAGE.txt           # Commit template

🎯 Getting Started

  1. New to the project? Start with the Main README
  2. Want to run tests? Check TESTING.md
  3. Setting up CI/CD? Read CI_CD.md
  4. Contributing? See README_TESTING_CI.md