Skip to content

Latest commit

 

History

History
69 lines (53 loc) · 2.7 KB

File metadata and controls

69 lines (53 loc) · 2.7 KB

Documentation Index

This folder contains all project documentation for TaskMeshAI.

Quick Links

Getting Started

Testing & QA

Code Review & Quality

Architecture & Design

Quality & Dependencies

Document Overview

Document Purpose Audience
ARCHITECTURE.md System design, components, data flow Developers, Architects
BUILD_SUMMARY.md Build process, deployment, environment setup DevOps, Developers
CODE_REVIEW_IMPLEMENTATION_CHECKLIST.md Step-by-step code review setup Developers, DevOps
CODE_REVIEW_SETUP.md Automated code review options and patterns Developers, DevOps
DEPENDENCY_AUDIT.md Dependencies, versions, vulnerabilities Security, DevOps
DEVELOPMENT.md Local setup, development workflow Developers
NEXT_STEPS.md Roadmap, improvements, features Product, Developers
SUPABASE_SETUP.md Database setup and connectivity verification Developers, DevOps
TESTING.md Test suite, coverage, test strategy QA, Developers
WALLET_GUIDE.md Wallet integration architecture and usage Developers
WALLET_IMPLEMENTATION.md Code walkthrough and implementation patterns Developers
WALLET_QUICK_REFERENCE.md Quick lookup for common wallet tasks Developers
WALLET_TESTING_CHECKLIST.md Practical wallet testing procedures QA, Developers

Contributing

When adding new documentation:

  1. Place files in this docs/ folder
  2. Update this index with a reference
  3. Use consistent formatting (Markdown)
  4. Include examples where helpful
  5. Keep content up-to-date with code changes

Quick Commands

# Run tests
pnpm test

# Check coverage
NODE_ENV=test pnpm exec jest --coverage

# Start development
pnpm dev

# Build for production
pnpm build