Skip to content

Improve clarity and correctness in Chapter 4 (Muxandplex) documentation#535

Open
MYMISERABLEMIND17 wants to merge 3 commits intoCircuitVerse:masterfrom
MYMISERABLEMIND17:fix-muxandplex-docs
Open

Improve clarity and correctness in Chapter 4 (Muxandplex) documentation#535
MYMISERABLEMIND17 wants to merge 3 commits intoCircuitVerse:masterfrom
MYMISERABLEMIND17:fix-muxandplex-docs

Conversation

@MYMISERABLEMIND17
Copy link
Copy Markdown

@MYMISERABLEMIND17 MYMISERABLEMIND17 commented Mar 4, 2026

Fixes #

Ref #

Changes done:

  • Task 1

Screenshots:

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 (add a link from the checks tab after checks complete)
  • Tried Squashing the commits into one

Summary by CodeRabbit

  • Documentation
    • Clarified descriptions of MSB and LSB detectors and the Decoder for clearer, more accurate explanations of behavior and outputs.
    • Minor formatting/metadata edits to documentation configuration to improve editing/maintenance workflows.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 4, 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: e4d7cec7-d52f-4f64-b25f-8b8b7a43f805

📥 Commits

Reviewing files that changed from the base of the PR and between 0e0866e and e40775e.

📒 Files selected for processing (1)
  • docusaurus.config.js
✅ Files skipped from review due to trivial changes (1)
  • docusaurus.config.js

Walkthrough

This pull request updates documentation in Chapter 4's 5muxandplex.md: MSB Detector wording now describes the position of the most significant bit as the leftmost 1 and clarifies the enable output; LSB Detector wording now describes the position of the least significant bit as the rightmost 1 and clarifies the enable output; Decoder wording now states it activates exactly one of the 2^N outputs corresponding to the binary input. docusaurus.config.js has only non-functional formatting edits around the editUrl line (blank-line changes).

Possibly related PRs

  • CircuitVerse/CircuitVerseDocs PR 525: Edits the same docs/chapter4/5muxandplex.md to correct MSB/LSB bit-position descriptions using aligned terminology.
🚥 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 describes the main change: improving clarity and correctness in Chapter 4 documentation, which aligns with the substantive edits to the muxandplex documentation and minor formatting fixes.
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
  • Post copyable unit tests in a comment

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.

@Yana-do-code
Copy link
Copy Markdown
Contributor

Yana-do-code commented Mar 5, 2026

@MYMISERABLEMIND17 can you please attach screenshots of the documentation text changes . Also your branch has conflicts that must be resolved .

@MYMISERABLEMIND17 MYMISERABLEMIND17 marked this pull request as draft March 5, 2026 06:06
@MYMISERABLEMIND17 MYMISERABLEMIND17 marked this pull request as ready for review March 5, 2026 06:07
@MYMISERABLEMIND17
Copy link
Copy Markdown
Author

Screenshot from 2026-03-05 11-41-13 Screenshot from 2026-03-05 11-41-02

just correct about " msb " and " lsb "

@Yana-do-code
Copy link
Copy Markdown
Contributor

@MYMISERABLEMIND17 Great ! But please place the screenshots in the pr description screenshot section .

@Yana-do-code
Copy link
Copy Markdown
Contributor

@Nihal4777 Kindly review it .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants