docs: MVP 문서와 현재 구현 범위 정합성 정리

[ohhalim]

docs: MVP 문서와 현재 구현 범위 정합성 정리

관련 이슈

closes #30

Summary by CodeRabbit

Release Notes

• Documentation

  • Updated API field naming: wallet and ledger responses now use availableBalance/lockedBalance and availableBalanceAfter/lockedBalanceAfter for clarity.
  • Refined order listing query parameters from status-based to limit/offset-based pagination.
  • Enhanced order creation and settlement transaction flow documentation with detailed procedural steps.
  • Clarified order response structure, including liquidity field specifications.
  • Improved MVP scope definitions and post-Phase 1 enhancements documentation.

• Chores

  • Updated configuration files to exclude local development resources.

[coderabbitai]

Caution

Review failed

Pull request was closed or merged during review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2fe0643b-84d5-43ff-a828-1fdab5468c60

📥 Commits

Reviewing files that changed from the base of the PR and between 76fd9af and d870786.

📒 Files selected for processing (9)

• .docs/API.md
• .docs/ERD.md
• .docs/ISSUES.md
• .docs/PRD.md
• .docs/Plan.md
• .docs/Reference.md
• .docs/TestPlan.md
• .gitignore
• README.md

---

📝 Walkthrough

Walkthrough

This PR aligns CoinFlow MVP documentation with current implementation state. API specs are updated with field name harmonization (availableBalance/lockedBalance, availableBalanceAfter/lockedBalanceAfter) and query parameter changes (limit/offset pagination, lastFillId filtering). MVP scope is clarified across multiple documents to distinguish Phase 1 features from Phase 1+ integrity measures (zero-quote prevention, dust-maker auto-cancel). Known issues are documented with resolution procedures (DevWalletController profiling, OrderBookRecoveryService recovery, Kafka infrastructure scope).

Changes

Documentation Alignment Across MVP Scope

Layer / File(s)	Summary
API Specification and Response Schema .docs/API.md	Order creation transaction flow is detailed with pre-validation, sequence issuance, wallet lock/revalidation, and post-commit orderbook updates. Wallet and ledger response fields renamed for consistency: available/locked → availableBalance/lockedBalance; availableAfter/lockedAfter → availableBalanceAfter/lockedBalanceAfter. Order list query parameters changed from status-based to limit+offset pagination. User fill queries now support lastFillId-based incremental filtering. Trade liquidity field rules clarified to return MAKER or TAKER based on created order perspective.
MVP Scope and Phase 1+ Feature Boundaries .docs/ERD.md, .docs/PRD.md, .docs/Plan.md, .docs/Reference.md	MVP exclusions refined to separate standard fee/dust policy (deferred) from Phase 1+ integrity measures: zero-quote prevention and dust-maker auto-cancel. Market-level sequential processing specification updated from queue to ReentrantLock-based ordering. Scope documents aligned on dev-only deposit API (DevWalletController with !prod profile), seed wallet balance initialization, and domain event persistence. Order creation procedure steps reordered to clarify self-trade validation and sequence issuance timing.
Known Issues and Recovery Procedures .docs/ISSUES.md	Deposit API profiling issue documented with resolution: separate WalletController (operations) from DevWalletController with !prod profile guard. OrderBook afterCommit recovery failure procedure documented: OrderBookRecoveryService performs metric-tracked rebuild with REQUIRES_NEW transaction, fallback to cancel_only=true on failure. Kafka scope clarified as local infrastructure only; spring-kafka/WebSocket integration deferred to Phase 2.
Test and Development Setup Documentation .docs/TestPlan.md, README.md, .gitignore	TestPlan ledger field assertions aligned with API spec naming. README integration test scope clarified to focus on decimal precision, foreign key constraints, transaction boundaries, and core consistency scenarios; concurrency and load testing deferred to next phase. .gitignore updated to exclude local-only .docs/interview/ and http/ scratch paths.

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly Related Issues

• PR #30 is directly linked and describes the exact scope of this documentation alignment work: MVP documents synchronization with current implementation state, including API response updates, scope clarifications, and known issue documentation.

🐰 Through fields and names we hop with care,
Scope clarified in documents fair,
Phase One and plus now clearly split,
Recovery flows and dev-only git,
MVP docs now match the deed! ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the PR's main objective: aligning MVP documentation with current implementation scope.
Linked Issues check	✅ Passed	All code-related objectives from issue #30 are met: API responses/parameters updated, MVP exclusions clarified, Phase 1 scope defined, and dev-only features separated from operations.
Out of Scope Changes check	✅ Passed	All changes are scoped to documentation updates aligning with implementation; no unrelated code changes or feature additions are present.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch chore/30/mvp-docs-alignment

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}