docs: reorganize documentation structure and remove local protocol copy#540
docs: reorganize documentation structure and remove local protocol copy#540
Conversation
- Remove docs/protocol/ directory (local copy of mostro.network/protocol) - Add protocol reference to CLAUDE.md and architecture/README.md pointing to official source - Create docs/guides/ for how-to documents (CONTRIBUTING, ADDING_NEW_LANGUAGE, MUTATION_TESTING, FIREBASE_LINUX_NOTE, DEBUG_RELEASE_CONFLICT) - Create docs/plans/ for pending implementation plans (CHAT_NOTIFICATIONS_PLAN) - Move architecture docs to docs/architecture/ (MULTI_MOSTRO_SUPPORT, FCM_IMPLEMENTATION, DISPUTE_CHAT_MULTIMEDIA_PLAN) - Move CI/CD docs to docs/ci/ (GITHUB_SECRETS_SETUP) - Consolidate NWC Phase 1-5 and QR Scanner (6 files) into single NWC_ARCHITECTURE.md - Rewrite LOGGING_IMPLEMENTATION.md (7-phase plan) as LOGGING_SYSTEM.md (architecture doc) - Rewrite LN_ADDRESS_CONFIRMATION_UX.md (plan) as LN_ADDRESS_CONFIRMATION.md (architecture doc) - Delete WEB_PWA_SUPPORT_PLAN.md (intentionally superseded, never implemented) - Update CHAT_NOTIFICATIONS_PLAN.md to reflect Phase 1 completed, Phase 2 in review, Phases 3-4 pending - Fix all cross-references in README.md, AGENTS.md, CLAUDE.md, key.properties.example, and internal doc links - Remove docs/architecture/build/.last_build_id (build artifact)
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
WalkthroughReorganized and updated documentation: moved many docs into new subdirectories ( Changes
Sequence Diagram(s)(omitted — changes are documentation-only and do not introduce new runtime control flow in this diff) Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/architecture/LOGGING_SYSTEM.md`:
- Around line 19-26: Add a language specifier (use "text") to the fenced code
block that starts with "Main Isolate:" so the opening ``` becomes ```text to
satisfy markdownlint MD040; update the single fenced block containing "Main
Isolate: logger (singleton) → MemoryLogOutput → UI (LogsScreen) ..." and the
Background Isolate line accordingly, leaving the block contents unchanged.
In `@docs/architecture/NWC_ARCHITECTURE.md`:
- Around line 38-39: Update the architecture doc to reflect that NWC currently
uses the shared app-wide Nostr connectivity rather than a dedicated Nostr()
instance: replace the claim about a "dedicated `Nostr()` instance" and relay
teardown on `disconnect()` with text stating that `Nostr.instance` is a shared
singleton and the `disconnect()` implementation in
lib/services/nwc/nwc_client.dart intentionally does NOT close relay WebSocket
connections to avoid breaking Mostro relays; mark dedicated-instance isolation
as future work (Phase 2) and apply the same change at the other referenced
locations (lines ~61 and ~97-100).
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: fda9a7c6-244f-4e60-9947-ea43091dad75
📒 Files selected for processing (58)
AGENTS.mdCLAUDE.mdREADME.mdandroid/key.properties.exampledocs/LN_ADDRESS_CONFIRMATION_UX.mddocs/LOGGING_IMPLEMENTATION.mddocs/NWC_PHASE1_IMPLEMENTATION.mddocs/NWC_PHASE2_IMPLEMENTATION.mddocs/NWC_PHASE3_IMPLEMENTATION.mddocs/NWC_PHASE4_IMPLEMENTATION.mddocs/NWC_PHASE5_IMPLEMENTATION.mddocs/QR_SCANNER_NWC_IMPLEMENTATION.mddocs/WEB_PWA_SUPPORT_PLAN.mddocs/architecture/BACKGROUND_NOTIFICATIONS_FIX.mddocs/architecture/DISPUTE_CHAT_MULTIMEDIA_PLAN.mddocs/architecture/FCM_IMPLEMENTATION.mddocs/architecture/LN_ADDRESS_CONFIRMATION.mddocs/architecture/LOGGING_SYSTEM.mddocs/architecture/MULTI_MOSTRO_SUPPORT.mddocs/architecture/NWC_ARCHITECTURE.mddocs/architecture/README.mddocs/architecture/REQUEST_ID_ANALYSIS.mddocs/ci/GITHUB_SECRETS_SETUP.mddocs/guides/ADDING_NEW_LANGUAGE.mddocs/guides/CONTRIBUTING.mddocs/guides/DEBUG_RELEASE_CONFLICT.mddocs/guides/FIREBASE_LINUX_NOTE.mddocs/guides/MUTATION_TESTING.mddocs/plans/CHAT_NOTIFICATIONS_PLAN.mddocs/protocol/SUMMARY.mddocs/protocol/actions.mddocs/protocol/admin_add_solver.mddocs/protocol/admin_cancel_order.mddocs/protocol/admin_settle_order.mddocs/protocol/cancel.mddocs/protocol/chat.mddocs/protocol/dispute.mddocs/protocol/fiatsent.mddocs/protocol/key_management.mddocs/protocol/list_disputes.mddocs/protocol/list_orders.mddocs/protocol/message_suggestions_for_actions.mddocs/protocol/new_buy_order.mddocs/protocol/new_buy_order_ln_address.mddocs/protocol/new_sell_order.mddocs/protocol/new_sell_range_order.mddocs/protocol/order_event.mddocs/protocol/other_events.mddocs/protocol/overview.mddocs/protocol/release.mddocs/protocol/restore_session.mddocs/protocol/seller_pay_hold_invoice.mddocs/protocol/take_buy.mddocs/protocol/take_buy_range_order.mddocs/protocol/take_sell.mddocs/protocol/take_sell_ln_address.mddocs/protocol/take_sell_range_order.mddocs/protocol/user_rating.md
💤 Files with no reviewable changes (38)
- docs/protocol/actions.md
- docs/protocol/SUMMARY.md
- docs/protocol/list_orders.md
- docs/protocol/new_sell_order.md
- docs/protocol/admin_add_solver.md
- docs/protocol/take_buy_range_order.md
- docs/QR_SCANNER_NWC_IMPLEMENTATION.md
- docs/NWC_PHASE3_IMPLEMENTATION.md
- docs/protocol/list_disputes.md
- docs/protocol/admin_cancel_order.md
- docs/protocol/admin_settle_order.md
- docs/protocol/cancel.md
- docs/protocol/key_management.md
- docs/NWC_PHASE1_IMPLEMENTATION.md
- docs/protocol/new_buy_order_ln_address.md
- docs/LOGGING_IMPLEMENTATION.md
- docs/protocol/release.md
- docs/protocol/order_event.md
- docs/protocol/restore_session.md
- docs/protocol/fiatsent.md
- docs/protocol/take_buy.md
- docs/protocol/new_sell_range_order.md
- docs/protocol/overview.md
- docs/protocol/new_buy_order.md
- docs/NWC_PHASE4_IMPLEMENTATION.md
- docs/protocol/seller_pay_hold_invoice.md
- docs/NWC_PHASE5_IMPLEMENTATION.md
- docs/protocol/other_events.md
- docs/protocol/chat.md
- docs/protocol/take_sell_range_order.md
- docs/protocol/take_sell_ln_address.md
- docs/protocol/user_rating.md
- docs/LN_ADDRESS_CONFIRMATION_UX.md
- docs/protocol/dispute.md
- docs/NWC_PHASE2_IMPLEMENTATION.md
- docs/protocol/take_sell.md
- docs/protocol/message_suggestions_for_actions.md
- docs/WEB_PWA_SUPPORT_PLAN.md
Summary by CodeRabbit