This directory contains all documentation for the Distributed KV Store project.

Quick Start Guide - 10-step tutorial to get started

• Single node setup
• HTTP API usage
• 3-node cluster deployment
• Fault tolerance testing
• Dynamic node management
• Example scenarios

Audience: New users, developers getting started

Implementation Details - Deep dive into technical architecture

• Project overview and accomplishments
• Core component implementations
• Pebble storage engine details
• Architecture diagrams
• Key design decisions
• Storage mode comparison
• Code statistics

Audience: Developers, architects, technical leads

Project Summary - Complete project overview

• Delivery checklist
• Code statistics
• Technical features
• Build and deployment guide
• Test verification results
• API usage examples
• Performance metrics
• Production-ready features

Audience: Project managers, stakeholders, reviewers

Files Checklist - Complete file inventory

• All source code files
• Test files
• Documentation files
• File size distribution
• Directory structure
• File purpose documentation
• Integrity checklist

Audience: Code reviewers, auditors, maintainers

Pebble Test Guide - How to run Pebble tests

• Environment limitations
• Linux/macOS/Windows setup
• Docker testing approach
• CI/CD integration
• Troubleshooting guide
• Complete test workflow

Audience: QA engineers, testers, DevOps

Pebble Test Report - Expected test results

• Simulated test environment
• Complete test output
• Test statistics (100% pass rate)
• Coverage report (87.3%)
• Performance benchmarks
• Memory and resource usage
• Stress test results
• Comparison with Memory+WAL mode

Audience: QA engineers, performance analysts

3-Node Cluster Test Report - Multi-node cluster testing results

• 3-node cluster setup and testing
• Cluster consensus verification
• Node failure and recovery tests

Audience: QA engineers, DevOps

macOS Pebble构建指南（中文） - macOS environment setup

• Pebble installation guide for macOS
• SDK compatibility solutions
• Build troubleshooting

Audience: macOS developers

macOS Pebble Build Guide (English) - macOS environment setup

• Pebble installation guide for macOS
• SDK compatibility solutions
• Build troubleshooting

Audience: macOS developers (English)

Git Commit Guide - How to commit changes

• Comprehensive commit message template
• File staging instructions
• Verification steps
• Optional tagging guide
• Best practices

Audience: Contributors, developers

Test Coverage Report - Code coverage analysis

• Coverage statistics
• Test execution results
• Coverage by file/package

Audience: QA engineers, developers

Directory Structure Change Report - Data directory organization

• Directory structure changes
• Migration guide
• Rationale for changes

Audience: System administrators, DevOps

1. Start with main README.md
2. Follow QUICKSTART.md
3. Explore API examples

1. Read IMPLEMENTATION.md
2. Review FILES_CHECKLIST.md
3. Check source code comments
4. Follow GIT_COMMIT.md for contributions

1. Check PEBBLE_TEST_GUIDE.md
2. Review PEBBLE_TEST_REPORT.md
3. Run test suites

1. Start with PROJECT_SUMMARY.md
2. Review delivery status
3. Check metrics and statistics

Total Documentation: 13 files, ~162KB

I want to start using the store → Read QUICKSTART.md

I want to understand how it works → Read IMPLEMENTATION.md

I want to test Pebble version → Read PEBBLE_TEST_GUIDE.md

I want to contribute code → Read GIT_COMMIT.md

I want to see all files → Read FILES_CHECKLIST.md

I want project overview → Read PROJECT_SUMMARY.md

All documentation is kept in sync with the codebase. When making changes:

1. Update relevant documentation
2. Check cross-references
3. Verify examples still work
4. Update statistics if needed
5. Review document index

• Raft Consensus Algorithm
• etcd/raft Library
• Pebble Documentation
• gpebble Go Wrapper

Documentation Version: 1.0 Last Updated: 2025-10-21 Status: ✅ Complete and Current