Added controlled inverter docs#513
Conversation
WalkthroughThe chapter 4 miscellaneous components documentation was updated to add a new "Controlled Inverter" section (gated inverter with an Enable input and high‑impedance output when disabled), insert an embedded live circuit and truth table, and reorder the miscellaneous navigation entries to include Controlled Inverter before TriState Buffer. The TriState Buffer truth table was renumbered to Table 4.25 and an image reference was removed. Changes: +60/−8 lines. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/chapter4/8misc.md`:
- Around line 319-369: The TriState Buffer section contains an orphaned caption
"Figure 4.19: Relevant attributes for the TriState circuit element" with no
preceding image; either insert the missing image/figure markup right before that
caption (e.g., an <img> or figure block showing the TriState attributes) or
remove the caption line entirely; locate the text by searching for the "TriState
Buffer" heading and the exact caption string "Figure 4.19: Relevant attributes
for the TriState circuit element" and update accordingly so the caption is not
left without an image.
🧹 Nitpick comments (1)
docs/chapter4/8misc.md (1)
319-369: Great documentation! Consider iframe formatting consistency.The Controlled Inverter documentation is well-structured and accurate. The truth table correctly represents the component's behavior (inversion when enabled, high impedance when disabled).
Minor formatting inconsistency: The embedded iframe at line 368 uses
width="500" height="500"with inline styles, while other iframes in the document consistently usewidth="600px" height="400px"with standard attributes. Consider standardizing for consistency.Optional style refinement: Lines 323-326 have three consecutive sentences beginning with "If", which slightly affects readability. Consider rewording the third sentence, e.g., "Users can change the orientation..." or "As needed, users may change...".
🎨 Suggested iframe formatting for consistency
-<iframe src="https://circuitverse.org/simulator/embed/controlled-inverter-192f44be-551e-4204-b495-ef7234705575?theme=&display_title=false&clock_time=true&fullscreen=true&zoom_in_out=true" style="border-width:; border-style: ; border-color:;" name="myiframe" id="projectPreview" scrolling="no" frameborder="1" marginheight="0px" marginwidth="0px" height="500" width="500" allowFullScreen></iframe> +<iframe + width="600px" + height="400px" + src="https://circuitverse.org/simulator/embed/controlled-inverter-192f44be-551e-4204-b495-ef7234705575" + id="projectPreview" + scrolling="no" + webkitAllowFullScreen + mozAllowFullScreen + allowFullScreen +> + {" "} +</iframe>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@docs/chapter4/8misc.md`:
- Line 368: The iframe element (id="projectPreview", name="myiframe") is missing
a descriptive title for screen readers; add a meaningful title attribute (e.g.,
title="Controlled inverter circuit preview") to the iframe tag so assistive tech
can identify the embedded circuit, ensuring the title succinctly describes the
content and purpose.
🧹 Nitpick comments (1)
docs/chapter4/8misc.md (1)
330-364: Clarify what “Z” means in the truth table.Consider a short note before/after the table so readers unfamiliar with tri‑state notation understand that “Z” means high‑impedance.
💡 Suggested tweak
Table 4.24: Truth table for a Controlled Inverter gate +> Note: **Z** denotes a high‑impedance (disconnected) output. + <table>
|
@Nihal4777 please review and merge :) |
Fixes #342
Ref #
Changes done:
Screenshots:
Preview Link(s):
✅️ By submitting this PR, I have verified the following
Summary by CodeRabbit