docs: enhance FSM page with state transition table, state labels, Moore vs Mealy comparison and quiz by VaibhavJindal7 · Pull Request #771 · CircuitVerse/Interactive-Book

VaibhavJindal7 · 2026-03-22T21:15:59Z

Fixes #769
Fixes #770

Changes done:

Added Moore vs Mealy comparison table
Added state transition table for vending machine
Added state labels explanation (M0, W5, W10 etc.)
Added binary arrow labels explanation (00, 01, 10)
Added Experiment section heading
Added quiz with 5 questions
Added status messages during Wait states
(Processing coin, Returning change, Enjoy your soda)

Screenshots

No UI changes for documentation.
JS fix adds status messages during processing states
so users understand what the machine is doing.

Preview Link(s):

✅️ By submitting this PR, I have verified the following

Checked to see if a similar PR has already been opened 🤔️
Reviewed the contributing guidelines 🔍️
Sample preview link added
Tried Squashing the commits into one

Summary by CodeRabbit

Documentation
- Added instructional material comparing Moore vs Mealy machines, a mnemonic, a detailed state transition table, explanations of state labels, an experiment section, and a five-question quiz.
User Experience
- Interactive soda machine now shows contextual status messages for inserting coins, processing, returning change, and dispensing soda. Removed the prior delayed re-enable behavior for coin input.

…re vs Mealy comparison and quiz

coderabbitai · 2026-03-22T21:16:15Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

Walkthrough

Updated docs/seq-design/fsm.md with a Moore vs Mealy comparison table and mnemonic, a state transition table for the soda vending FSM, an explanation of state-label symbols and binary transition-arrow labels, a note about the diagram’s internal “20” value, an “Experiment” section, and a five-question Quiz. Modified assets/js/interactive_soda_machine.js to add a statusText UI element, set state-specific status messages and UI calls (including enableButtons(), dropSoda(), and dropChange()), make dropCoin() set “Processing coin...”, and remove the previous delayed re-enable gating logic. No declarations of exported/public entities were changed.

🚥 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 describes the main changes to the documentation: it mentions the state transition table, state labels, Moore vs Mealy comparison, and quiz additions.
Linked Issues check	✅ Passed	The PR addresses all coding requirements from `#769` (state label explanation, binary arrow labels, state transition table, Moore vs Mealy comparison) and `#770` (button disable logic during wait states, user feedback messages).
Out of Scope Changes check	✅ Passed	All changes directly relate to the linked issues: documentation enhancements address `#769` requirements, and interactive JS changes address `#770` button/feedback issues. No unrelated modifications detected.
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

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

Actionable comments posted: 3

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 26de1b87-d95f-4141-8a34-93fe15aaa609

📥 Commits

Reviewing files that changed from the base of the PR and between ac91c0a and c6320b2.

📒 Files selected for processing (1)

docs/seq-design/fsm.md

…ring wait states

coderabbitai

Actionable comments posted: 1

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 05df2d73-08fd-465a-b3b1-3ae30f7db15c

📥 Commits

Reviewing files that changed from the base of the PR and between c6320b2 and 6ec73f6.

📒 Files selected for processing (1)

assets/js/interactive_soda_machine.js

…d spelling

VaibhavJindal7 · 2026-03-22T22:23:35Z

Addressed all CodeRabbit review comments:

Fixed spelling: "labeled" → "labelled"
Fixed Mealy output timing description
Fixed grammar: "Lets" → "Let's"
Fixed status message logic in enableButtons function

coderabbitai

Actionable comments posted: 4

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b8903096-8da2-4c28-8169-08b57efcf55a

📥 Commits

Reviewing files that changed from the base of the PR and between 6ec73f6 and d734a32.

📒 Files selected for processing (2)

assets/js/interactive_soda_machine.js
docs/seq-design/fsm.md

…der, state names and quiz

coderabbitai

Actionable comments posted: 1

♻️ Duplicate comments (1)

docs/seq-design/fsm.md (1)
173-175: ⚠️ Potential issue | 🟡 Minor

Hyphenate compound adjective "above-mentioned".

Static analysis correctly flags that "above mentioned" should be hyphenated when used as a compound adjective before a noun.
📝 Proposed fix
 Let's try the soda can vending machine and look for 
 the corresponding state changes in the FSM diagram 
-for each of the above mentioned possibilities.
+for each of the above-mentioned possibilities.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 64839491-0298-4200-9344-072a0a8c2308

📥 Commits

Reviewing files that changed from the base of the PR and between d734a32 and 3475319.

📒 Files selected for processing (2)

assets/js/interactive_soda_machine.js
docs/seq-design/fsm.md

coderabbitai · 2026-03-23T03:46:54Z

+3.  A Mealy machine has 3 states and one binary input.
+   The minimum number of rows in its state
+   transition table will be:
+   1. 3
+   2. 6
+   3. 8
+   4. 9


⚠️ Potential issue | 🟡 Minor

Fix formatting in question 3.

Line 194 has a double space after "3." (3. A Mealy), and the answer options at lines 197-200 have inconsistent indentation (3 spaces vs expected 0). This may cause rendering issues with the quiz component.

📝 Proposed fix

-3. A Mealy machine has 3 states and one binary input. - The minimum number of rows in its state - transition table will be: - 1. 3 - 2. 6 - 3. 8 - 4. 9 +3. A Mealy machine has 3 states and one binary input. + The minimum number of rows in its state + transition table will be: + 1. 3 + 2. 6 + 3. 8 + 4. 9

🧰 Tools

🪛 markdownlint-cli2 (0.21.0)

[warning] 197-197: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 3

(MD005, list-indent)

[warning] 198-198: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 3

(MD005, list-indent)

[warning] 199-199: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 3

(MD005, list-indent)

[warning] 200-200: Inconsistent indentation for list items at the same level
Expected: 0; Actual: 3

(MD005, list-indent)

VaibhavJindal7 · 2026-03-23T03:47:25Z

Addressed all CodeRabbit review comments:

Fixed button re-enable logic - moved enableButtons() call to case 2 and case 4 in switch statement and removed the fixed 4s timeout.
Renamed "Coin Input" column to "Input / Condition" in state transition table .
Fixed state name W5 -> W0 to match the diagram.
Fixed quiz question 3 wording to "one binary input".

VaibhavJindal7 · 2026-03-23T04:19:40Z

Addressed remaining CodeRabbit review comments:

Fixed hyphenation: "above mentioned" → "above-mentioned"
Fixed double space after "3." in quiz question 3

magic-peach

JS fix looks correct — removing the 3300ms setTimeout that was calling enableButtons() when state <= 4 was the root cause. States 5 and 6 (W15, W20) were being missed, and now the enable/disable flow is driven cleanly from the switch cases in update().

Docs additions are solid: the Moore vs Mealy table, state transition table, and label glossary address everything reported in #769. Quiz questions are well-formed.

One nit: fsm.md is missing a newline at end of file (the diff shows \ No newline at end of file). Worth a quick fix before merge.

VaibhavJindal7 · 2026-05-26T18:23:33Z

Addressed the remaining review feedback by adding the missing newline at the end of fsm.md.

All requested changes should now be resolved.
@coderabbitai review

coderabbitai · 2026-05-26T18:23:40Z

Your plan includes 2 PR reviews per hour. Reviews are available now.

docs: enhance FSM page with state transition table, state labels, Moo…

c6320b2

…re vs Mealy comparison and quiz

coderabbitai Bot requested changes Mar 22, 2026

View reviewed changes

Comment thread docs/seq-design/fsm.md Outdated

Comment thread docs/seq-design/fsm.md Outdated

Comment thread docs/seq-design/fsm.md Outdated

fix: remove misleading 20 from FSM circles and add status messages du…

6ec73f6

…ring wait states

coderabbitai Bot requested changes Mar 22, 2026

View reviewed changes

Comment thread assets/js/interactive_soda_machine.js Outdated

VaibhavJindal7 added 2 commits March 23, 2026 03:42

fix: address CodeRabbit review comments

d734a32

fix: address CodeRabbit review comments - fix status message logic an…

f1d7fc0

…d spelling

coderabbitai Bot requested changes Mar 22, 2026

View reviewed changes

Comment thread assets/js/interactive_soda_machine.js

Comment thread docs/seq-design/fsm.md Outdated

Comment thread docs/seq-design/fsm.md

Comment thread docs/seq-design/fsm.md Outdated

VaibhavJindal7 mentioned this pull request Mar 22, 2026

bug: FSM vending machine buttons re-enable during wait states causing incorrect change calculation #770

Open

fix: address CodeRabbit review comments - fix button logic, table hea…

3475319

…der, state names and quiz

coderabbitai Bot requested changes Mar 23, 2026

View reviewed changes

fix: fix hyphenation and formatting in fsm.md

0303aa5

magic-peach approved these changes May 25, 2026

View reviewed changes

fix: add newline at end of fsm.md

207ff6e

Uh oh!

Conversation

VaibhavJindal7 commented Mar 22, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes done:

Screenshots

Preview Link(s):

✅️ By submitting this PR, I have verified the following

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Mar 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Walkthrough

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

VaibhavJindal7 commented Mar 22, 2026

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai Bot Mar 23, 2026

Choose a reason for hiding this comment

Uh oh!

VaibhavJindal7 commented Mar 23, 2026

Uh oh!

VaibhavJindal7 commented Mar 23, 2026

Uh oh!

magic-peach left a comment

Choose a reason for hiding this comment

Uh oh!

VaibhavJindal7 commented May 26, 2026

Uh oh!

coderabbitai Bot commented May 26, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

VaibhavJindal7 commented Mar 22, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Mar 22, 2026 •

edited

Loading