Skip to content

docs: reorganize documentation structure and remove local protocol copy#540

Merged
grunch merged 2 commits intomainfrom
documentation-reorg
Mar 20, 2026
Merged

docs: reorganize documentation structure and remove local protocol copy#540
grunch merged 2 commits intomainfrom
documentation-reorg

Conversation

@Catrya
Copy link
Member

@Catrya Catrya commented Mar 20, 2026

  • 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)

Summary by CodeRabbit

  • Documentation
    • Reorganized docs into clearer architecture/guides/ci sections and updated many internal links.
    • Added architecture pages for centralized logging, NWC (Wallet Connect) integration, and Lightning Address confirmation UX.
    • Replaced local protocol copies with a pointer to the official Mostro protocol reference.
    • Removed multiple deprecated protocol and feature-spec pages to streamline current documentation.

  - 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)
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 20, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b3cd17d2-9656-4bfc-9996-1c9376cefd9f

📥 Commits

Reviewing files that changed from the base of the PR and between c591655 and f950b91.

📒 Files selected for processing (1)
  • docs/architecture/LOGGING_SYSTEM.md
✅ Files skipped from review due to trivial changes (1)
  • docs/architecture/LOGGING_SYSTEM.md

Walkthrough

Reorganized and updated documentation: moved many docs into new subdirectories (docs/architecture, docs/guides, docs/ci), added architecture references (logging, NWC, LN address confirmation), removed a large set of protocol and phase-specific docs, and updated cross-reference links. No runtime or exported/public code changes.

Changes

Cohort / File(s) Summary
Path Reference Updates
AGENTS.md, CLAUDE.md, README.md, android/key.properties.example, docs/guides/DEBUG_RELEASE_CONFLICT.md, docs/architecture/BACKGROUND_NOTIFICATIONS_FIX.md, docs/architecture/FCM_IMPLEMENTATION.md, docs/architecture/REQUEST_ID_ANALYSIS.md, docs/architecture/MULTI_MOSTRO_SUPPORT.md
Updated documentation links and comments to point to new locations under docs/architecture/, docs/guides/, and docs/ci/ (e.g., logging, adding-language, GitHub secrets, Firebase Linux note). No code changes.
Architecture Documentation Addition
docs/architecture/LOGGING_SYSTEM.md, docs/architecture/NWC_ARCHITECTURE.md, docs/architecture/LN_ADDRESS_CONFIRMATION.md, docs/architecture/README.md
Added new architecture-level docs: centralized logging system (singleton/logger usage, main vs background isolate flow, config keys), NWC (NIP-47) integration architecture and flows, LN address confirmation UX, and architecture README linking to official protocol reference.
Protocol Documentation Removal
docs/protocol/... (many files; e.g., SUMMARY.md, overview.md, order_event.md, chat.md, take_*.md, new_*.md, admin_*.md, dispute.md, key_management.md, ...)
Deleted extensive Mostro protocol documentation (numerous protocol pages). Content removed includes event schemas, example JSON, action flows, and protocol guides — readers are directed to the official Mostro protocol repository.
Feature Doc Removal / Consolidation
docs/LN_ADDRESS_CONFIRMATION_UX.md, docs/LOGGING_IMPLEMENTATION.md, docs/NWC_PHASE1_IMPLEMENTATION.md, docs/NWC_PHASE2_IMPLEMENTATION.md, docs/NWC_PHASE3_IMPLEMENTATION.md, docs/NWC_PHASE4_IMPLEMENTATION.md, docs/NWC_PHASE5_IMPLEMENTATION.md, docs/QR_SCANNER_NWC_IMPLEMENTATION.md, docs/WEB_PWA_SUPPORT_PLAN.md
Removed or consolidated phase/feature-level docs (NWC phase docs, QR scanner, web PWA plan, old logging implementation, LN UX). Some content was consolidated into new docs/architecture/*; others removed in favor of external references.
Plan Status Updates
docs/plans/CHAT_NOTIFICATIONS_PLAN.md
Updated phase status labels (Phase 1: COMPLETED — "Merged to main"; Phase 2: IN REVIEW — "Open PR, pending merge"; Phases 3–4: marked PENDING).

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

  • AndreaDiazCorreia
  • grunch

"I hopped through folders, neat and spry,
Moved the maps where curious minds may spy,
Old protocol pages sent to their home,
New architecture docs now proudly roam.
With a twitch of nose and a joyful cheer — docs tidy, clear! 🥕"

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title concisely and accurately summarizes the main objectives: reorganizing the documentation structure and removing the local protocol copy. It is specific, clear, and directly related to the primary changes in the changeset.
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 documentation-reorg
📝 Coding Plan
  • Generate coding plan for human review comments

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

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

📥 Commits

Reviewing files that changed from the base of the PR and between 0af6476 and c591655.

📒 Files selected for processing (58)
  • AGENTS.md
  • CLAUDE.md
  • README.md
  • android/key.properties.example
  • docs/LN_ADDRESS_CONFIRMATION_UX.md
  • docs/LOGGING_IMPLEMENTATION.md
  • docs/NWC_PHASE1_IMPLEMENTATION.md
  • docs/NWC_PHASE2_IMPLEMENTATION.md
  • docs/NWC_PHASE3_IMPLEMENTATION.md
  • docs/NWC_PHASE4_IMPLEMENTATION.md
  • docs/NWC_PHASE5_IMPLEMENTATION.md
  • docs/QR_SCANNER_NWC_IMPLEMENTATION.md
  • docs/WEB_PWA_SUPPORT_PLAN.md
  • docs/architecture/BACKGROUND_NOTIFICATIONS_FIX.md
  • docs/architecture/DISPUTE_CHAT_MULTIMEDIA_PLAN.md
  • docs/architecture/FCM_IMPLEMENTATION.md
  • docs/architecture/LN_ADDRESS_CONFIRMATION.md
  • docs/architecture/LOGGING_SYSTEM.md
  • docs/architecture/MULTI_MOSTRO_SUPPORT.md
  • docs/architecture/NWC_ARCHITECTURE.md
  • docs/architecture/README.md
  • docs/architecture/REQUEST_ID_ANALYSIS.md
  • docs/ci/GITHUB_SECRETS_SETUP.md
  • docs/guides/ADDING_NEW_LANGUAGE.md
  • docs/guides/CONTRIBUTING.md
  • docs/guides/DEBUG_RELEASE_CONFLICT.md
  • docs/guides/FIREBASE_LINUX_NOTE.md
  • docs/guides/MUTATION_TESTING.md
  • docs/plans/CHAT_NOTIFICATIONS_PLAN.md
  • docs/protocol/SUMMARY.md
  • docs/protocol/actions.md
  • docs/protocol/admin_add_solver.md
  • docs/protocol/admin_cancel_order.md
  • docs/protocol/admin_settle_order.md
  • docs/protocol/cancel.md
  • docs/protocol/chat.md
  • docs/protocol/dispute.md
  • docs/protocol/fiatsent.md
  • docs/protocol/key_management.md
  • docs/protocol/list_disputes.md
  • docs/protocol/list_orders.md
  • docs/protocol/message_suggestions_for_actions.md
  • docs/protocol/new_buy_order.md
  • docs/protocol/new_buy_order_ln_address.md
  • docs/protocol/new_sell_order.md
  • docs/protocol/new_sell_range_order.md
  • docs/protocol/order_event.md
  • docs/protocol/other_events.md
  • docs/protocol/overview.md
  • docs/protocol/release.md
  • docs/protocol/restore_session.md
  • docs/protocol/seller_pay_hold_invoice.md
  • docs/protocol/take_buy.md
  • docs/protocol/take_buy_range_order.md
  • docs/protocol/take_sell.md
  • docs/protocol/take_sell_ln_address.md
  • docs/protocol/take_sell_range_order.md
  • docs/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

Copy link
Member

@grunch grunch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@grunch grunch merged commit f76ab3d into main Mar 20, 2026
2 checks passed
@grunch grunch deleted the documentation-reorg branch March 20, 2026 13:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants