Skip to content

fix: ORDER_STATES.md post-merge corrections - #12

Merged
grunch merged 2 commits into
mainfrom
docs/order-states-post-merge-fixes
Mar 23, 2026
Merged

fix: ORDER_STATES.md post-merge corrections#12
grunch merged 2 commits into
mainfrom
docs/order-states-post-merge-fixes

Conversation

@grunch

@grunch grunch commented Mar 23, 2026

Copy link
Copy Markdown
Member
  • camelCase → kebab-case for all actions (take-sell, add-invoice, etc.)
  • Fixed admin-cancel → canceled-by-admin (consistent across all tables)
  • Fixed active color: Blue (not Green) in Appendix E
  • Fixed cooperativelyCanceled → cooperatively-canceled
  • Code blocks have proper language tags (text, rust, dart)

Summary by CodeRabbit

Documentation

  • Standardized order/action/status identifiers to a consistent kebab-case format across the protocol docs
  • Updated all state transition tables, action-to-status mapping, and UI/state transition notes to the new naming
  • Revised cooperative-cancel guidance and protocol flow examples to match updated identifiers
  • Normalized fenced-code block formatting for clearer examples

- camelCase → kebab-case for all actions (take-sell, add-invoice, etc.)
- Fixed admin-cancel → canceled-by-admin (consistent across all tables)
- Fixed active color: Blue (not Green) in Appendix E
- Fixed cooperativelyCanceled → cooperatively-canceled
- Code blocks have proper language tags (text, rust, dart)
@coderabbitai

coderabbitai Bot commented Mar 23, 2026

Copy link
Copy Markdown
Contributor

Caution

Review failed

Pull request was closed or merged during review

Walkthrough

Renames Mostro protocol state/action identifiers in ORDER_STATES.md from camelCase/PascalCase to kebab-case, updating all transition tables, state mappings, cooperative-cancel flow descriptions, UI references, and code block delimiters.

Changes

Cohort / File(s) Summary
Protocol specification (single file)
.specify/v1-reference/ORDER_STATES.md
Converted all action/status identifiers and references from camelCase/PascalCase to kebab-case across transition tables, state-machine descriptions, cooperative-cancel and restore-flow sections, UI/state matrices; normalized fenced-code block delimiters.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • grunch

Poem

🐰 Kebabs over camels, dashes take the lead,
States march neatly, each name now freed.
Tables aligned, transitions tidy and bright,
A rabbit hops by, delighted in the sight. 🥕✨

🚥 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 'fix: ORDER_STATES.md post-merge corrections' accurately describes the main change: documentation corrections to the ORDER_STATES.md file, specifically converting naming conventions from camelCase to kebab-case and fixing other post-merge issues.
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/order-states-post-merge-fixes

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: 2

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
.specify/v1-reference/ORDER_STATES.md (1)

379-379: ⚠️ Potential issue | 🟠 Major

Fix all invalid fenced code block closings in .specify/v1-reference/ORDER_STATES.md.

Closing fences must be plain triple backticks; language identifiers like text, rust, dart break rendering in many Markdown processors. Found 16 invalid closings:

  • ```text at lines: 343, 379, 383, 420, 424, 440, 707, 716
  • ```rust at lines: 544, 583, 807, 845
  • ```dart at lines: 587, 618, 849, 864

Replace all with plain ```.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.specify/v1-reference/ORDER_STATES.md at line 379, Replace all invalid
fenced code block closings that include language identifiers with plain triple
backticks: find and replace occurrences of "```text", "```rust", and "```dart"
used as closing fences in the markdown and change them to "```" so the closing
fence is exactly three backticks; specifically update each closing fence
instance that currently reads ```text, ```rust, or ```dart to simply ```,
ensuring code blocks render correctly.
🤖 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_STATES.md:
- Line 455: The status identifier is inconsistent (uses both
`cooperativelyCanceled` and `cooperatively-canceled`); update all occurrences to
the canonical kebab-case `cooperatively-canceled` across the markdown tables and
labels (e.g., replace `cooperativelyCanceled` in the ORDER_STATES table and the
other occurrences referenced like 785 and 797) so every status key and any
related `statusWaiting` mappings use `cooperatively-canceled` consistently.
- Around line 524-529: There is a contradictory transition for event
`add-invoice` when current state is `payment-failed`: one table row
(`payment-failed` + `add-invoice` -> `waiting-payment`) conflicts with later
rows (lines 694-695) that state the status is preserved as `payment-failed`;
pick the intended behavior and make the tables consistent—either change the
first occurrence (`payment-failed` + `add-invoice`) to preserve status
`payment-failed` (so the target/status columns reflect `payment-failed`), or
update the later occurrences (lines referencing `payment-failed` preservation)
to show the transition to `waiting-payment`; ensure both the state column and
resulting status/output columns match for the `payment-failed` + `add-invoice`
transition.

---

Outside diff comments:
In @.specify/v1-reference/ORDER_STATES.md:
- Line 379: Replace all invalid fenced code block closings that include language
identifiers with plain triple backticks: find and replace occurrences of
"```text", "```rust", and "```dart" used as closing fences in the markdown and
change them to "```" so the closing fence is exactly three backticks;
specifically update each closing fence instance that currently reads ```text,
```rust, or ```dart to simply ```, ensuring code blocks render correctly.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 7e5ce98d-a84a-4fb2-9c49-a0da2901b612

📥 Commits

Reviewing files that changed from the base of the PR and between b0429a4 and c4b96e8.

📒 Files selected for processing (1)
  • .specify/v1-reference/ORDER_STATES.md

Comment thread .specify/v1-reference/ORDER_STATES.md Outdated
Comment thread .specify/v1-reference/ORDER_STATES.md
- Fixed cooperativelyCanceled → cooperatively-canceled (line 455)
- Fixed code block closing fences (removed language tags from closing)
- Fixed payment-failed + add-invoice documentation to match v1 FSM
  (transitions to waiting-payment, not preserved)
@grunch
grunch merged commit 1397232 into main Mar 23, 2026
1 check was pending
@grunch
grunch deleted the docs/order-states-post-merge-fixes branch March 23, 2026 19:07
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