Skip to content

docs: HOME, NAVIGATION, ORDER_BOOK & ORDER_CREATION specs - #21

Merged
grunch merged 2 commits into
mainfrom
docs/home-navigation-spec
Mar 24, 2026
Merged

docs: HOME, NAVIGATION, ORDER_BOOK & ORDER_CREATION specs#21
grunch merged 2 commits into
mainfrom
docs/home-navigation-spec

Conversation

@mostronatorcoder

@mostronatorcoder mostronatorcoder Bot commented Mar 24, 2026

Copy link
Copy Markdown
Contributor

Summary

Specs for sections 2 and 3: HOME & NAVIGATION and ORDER CREATION.

New specs

File Description
HOME_SCREEN.md HomeScreen: tabs (Buy/Sell BTC), order list, filters, pull-to-refresh, FAB, drawer overlay, bottom nav
NAVIGATION_ROUTES.md Complete GoRouter routing map: 26 routes, auth guards, bottom nav, drawer navigation, deep link handling
ORDER_BOOK.md Public order book (HomeScreen) vs My Trades, filters, OrderListItem, OrderFilter dialog
ORDER_CREATION.md AddOrderScreen: form fields, validation, CreateOrderModel, AddOrderNotifier, MostroService.publishOrder, post-creation flow

Updated specs

File Changes
DRAWER_MENU.md Complete rewrite: drawerProvider pattern, PopScope back button, overlay implementation
README.md Index updated with new specs
AUTHENTICATION.md Cross-reference to navigation
SESSION_AND_KEY_MANAGEMENT.md Cross-reference to order creation

Based on code analysis of mostro-mobile v1. All documented behaviors verified against actual Flutter source code.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive specification for the order creation flow, detailing validation rules, form field behavior, payment method handling, and API lifecycle.
    • Updated reference documentation with cross-references to the new order creation specification.

New spec:
- ORDER_CREATION.md: AddOrderScreen, create order flow, form fields, validation, CreateOrderModel, create_order_provider, FSM states for new orders

Updated:
- Cross-references from existing specs (HOME_SCREEN, NAVIGATION, etc.)
@grunch

grunch commented Mar 24, 2026

Copy link
Copy Markdown
Member

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Mar 24, 2026

Copy link
Copy Markdown
Contributor
✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai

coderabbitai Bot commented Mar 24, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 975bcc43-0cb8-4670-b0d6-b909c2760733

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Walkthrough

This PR adds comprehensive specification documentation for the order-creation flow in Mostro Mobile. A new ORDER_CREATION.md file documents the /add_order route, screen initialization, form fields, validation rules, Order model construction, and Nostr request/response lifecycle. Cross-references are added throughout related documentation.

Changes

Cohort / File(s) Summary
Order Creation Specification
ORDER_CREATION.md
New comprehensive documentation file (252 lines) covering the complete /add_order flow: route registration, AddOrderScreen state initialization, form fields (fiat currency, amounts, payment methods, pricing models, lightning address), submit validation rules, amount validation logic, Order model construction for simple/range and market/fixed orders, and Nostr request/response lifecycle including session management and error handling.
Documentation Cross-References
AUTHENTICATION.md, NAVIGATION_ROUTES.md, SESSION_AND_KEY_MANAGEMENT.md, README.md
Added or updated entries linking to the new ORDER_CREATION.md specification. AUTHENTICATION.md adds sub-bullet in "Create Your Own Offer" section; NAVIGATION_ROUTES.md updates /add_order route description and cross-references table; SESSION_AND_KEY_MANAGEMENT.md adds "Ver también" reference in Order Creation Flow section; README.md adds index entry with reference to AddOrderScreen.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰 Hop, hop! The specs now bloom,
With ORDER_CREATION's guided room,
Each link connects with gentle care,
Navigation docs everywhere!

🚥 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 accurately summarizes the main changes: adding documentation specs for HOME, NAVIGATION, ORDER_BOOK, and ORDER_CREATION modules.
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 docs/home-navigation-spec

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.specify/v1-reference/ORDER_CREATION.md:
- Line 8: Fix the typo in the markdown entry where the path string contains
"notfiers"; update the reference
`lib/features/order/notfiers/add_order_notifier.dart` to the correct
`lib/features/order/notifiers/add_order_notifier.dart` so the documented path
matches the actual notifier filename.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3cf155d6-5e5c-4f9e-bc89-5b36a7616fc8

📥 Commits

Reviewing files that changed from the base of the PR and between 21c5f53 and 6bd639b.

📒 Files selected for processing (5)
  • .specify/v1-reference/AUTHENTICATION.md
  • .specify/v1-reference/NAVIGATION_ROUTES.md
  • .specify/v1-reference/ORDER_CREATION.md
  • .specify/v1-reference/README.md
  • .specify/v1-reference/SESSION_AND_KEY_MANAGEMENT.md

Comment thread .specify/v1-reference/ORDER_CREATION.md Outdated
@grunch
grunch merged commit f88b518 into main Mar 24, 2026
1 check passed
@grunch
grunch deleted the docs/home-navigation-spec branch March 24, 2026 16:34
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.

1 participant