Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/chapter1/1introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ slug : /
{" "}
</iframe>

Inspired by Logisim, CircuitVerse is an open-source educational tool for designing and visualizing digital logic circuit simulations in the cloud. Users including educators, students, electronic engineers, and hobbyists can play with digital circuit simulations from their browsers for exploring different “what-if” scenarios. As required, a user can share their creations using unique circuit URLs, or fork different contributions of the CircuitVerse community to yield their curiosity. Figure 1 shares a screenshot of a ripple carry adder simulation built using CircuitVerse.
Inspired by Logisim, CircuitVerse is an open-source educational tool for designing and visualizing digital logic circuit simulations in the cloud. Users, including educators, students, electronic engineers, and hobbyists, can play with digital circuit simulations from their browsers for exploring different “what-if” scenarios. As required, a user can share their creations using unique circuit URLs, or fork different contributions of the CircuitVerse community to yield their curiosity. Figure 1 shares a screenshot of a ripple carry adder simulation built using CircuitVerse.

![](/img/img_chapter1/1.1.png)
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.

⚠️ Potential issue | 🟡 Minor

Images are missing alt text (MD045 — accessibility).

![](/img/img_chapter1/1.1.png) has no alt text, and the same pattern appears at lines 33 and 44. Screen readers skip these images entirely, violating basic accessibility standards.

♿ Proposed fix (apply to all three images)
-![](/img/img_chapter1/1.1.png)
+![Ripple Carry Adder simulation built using CircuitVerse](/img/img_chapter1/1.1.png)
-![](/img/img_chapter1/1.2.png)
+![Educators managing classroom learning goals on CircuitVerse platform](/img/img_chapter1/1.2.png)
-![](/img/img_chapter1/1.3.png)
+![CircuitVerse community forum for sharing ideas and resources](/img/img_chapter1/1.3.png)
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)

[warning] 25-25: Images should have alternate text (alt text)

(MD045, no-alt-text)

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

In `@docs/chapter1/1introduction.md` at line 25, The image markdown entries like
`![](/img/img_chapter1/1.1.png)` (and the other two similar occurrences) lack
alt text; update each Markdown image tag to include meaningful alt text that
briefly describes the image content (e.g., `![Brief description](...)`) so
screen readers can convey the information—apply the same change to the other two
image tags at lines where `![](/img/img_chapter1/1.1.png)`-style syntax appears.


<div align="center">
<em>Figure 1.1: Ripple Carry Adder simulation built using CircuitVerse</em>
</div>

Developed for educators by educators, the CircuitVerse platform delivers high class learning experience in a scalable way. Educators can manage, track, and achieve their classroom learning goals in a single, powerful solution. They can create and manage different student groups, post different assignments, define submission deadlines and add or export grades (refer Figure 2). Using the CircuitVerse Chrome extension, educators can embed live circuits in their Google Slides and demonstrate concepts without navigating across different tabs. Alternatively, they can also export images or embed iFrames within their webpages.
Developed for educators by educators, the CircuitVerse platform delivers a high-quality learning experience in a scalable way. Educators can manage, track, and achieve their classroom learning goals in a single, powerful solution. They can create and manage different student groups, post different assignments, define submission deadlines and add or export grades (refer Figure 2). Using the CircuitVerse Chrome extension, educators can embed live circuits in their Google Slides and demonstrate concepts without navigating across different tabs. Alternatively, they can also export images or embed iframes within their webpages.

![](/img/img_chapter1/1.2.png)

Expand All @@ -51,7 +51,7 @@ As the CircuitVerse community grows, educators and students can join the online
</em>
</div>

Watch the below video for a quick demonstration of the CircuitVerse platform.
Watch the video below for a quick demonstration of the CircuitVerse platform.

<div>
<iframe
Expand Down
10 changes: 5 additions & 5 deletions docs/chapter1/2keyfeatures.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,19 @@ This section shares key features of the CircuitVerse simulator.
<em>Figure 1.4: Some of the key features of the CircuitVerse simulator</em>
</div>

1. **Build and simulate your circuits in the cloud**: Create and run your simulations in your browser without the hassle of software installation or operating system dependent instructions. Since the process of circuit creation and simulation is seamless, users can edit and troubleshoot their circuit design or apply changes while the simulation is running. Users can save and open their circuits online (against the user’s dashboard) or offline (locally on their machine).
1. **Build and simulate your circuits in the cloud**: Create and run your simulations in your browser without the hassle of software installation or operating-system-dependent instructions. Since the process of circuit creation and simulation is seamless, users can edit and troubleshoot their circuit design or apply changes while the simulation is running. Users can save and open their circuits online (against the user’s dashboard) or offline (locally on their machine).

2. **Transform your ideas using a powerful, intuitive and interactive schematic editor**:

- **Design using an easy-to-use interactive schematic editor**: As users drag and drop circuit elements on the canvas, horizontal and vertical wires can be drawn to complete the circuit connections. The wires are color coded to test and analyze the circuit simulations with ease.
- **Design using an easy-to-use interactive schematic editor**: As users drag and drop circuit elements on the canvas, horizontal and vertical wires can be drawn to complete the circuit connections. The wires are color-coded to test and analyze the circuit simulations with ease.
- **Customize input attributes of circuit components**: CircuitVerse includes a vast library of circuit elements that range from basic gates to register transfer level design, and from basic input/output to system level components. Most of the CircuitVerse components include customizable attributes for building complex designs within the simulator.
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.

⚠️ Potential issue | 🟡 Minor

Missing hyphen in "system-level components".

Consistent with the other compound-adjective hyphenation corrections in this PR, "system level components" should be "system-level components".

✏️ Proposed fix
-   - **Customize input attributes of circuit components**: CircuitVerse includes a vast library of circuit elements that range from basic gates to register transfer level design, and from basic input/output to system level components. Most of the CircuitVerse components include customizable attributes for building complex designs within the simulator.
+   - **Customize input attributes of circuit components**: CircuitVerse includes a vast library of circuit elements that range from basic gates to register transfer level design, and from basic input/output to system-level components. Most of the CircuitVerse components include customizable attributes for building complex designs within the simulator.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- **Customize input attributes of circuit components**: CircuitVerse includes a vast library of circuit elements that range from basic gates to register transfer level design, and from basic input/output to system level components. Most of the CircuitVerse components include customizable attributes for building complex designs within the simulator.
- **Customize input attributes of circuit components**: CircuitVerse includes a vast library of circuit elements that range from basic gates to register transfer level design, and from basic input/output to system-level components. Most of the CircuitVerse components include customizable attributes for building complex designs within the simulator.
🧰 Tools
🪛 LanguageTool

[grammar] ~22-~22: Use a hyphen to join words.
Context: ...n, and from basic input/output to system level components. Most of the CircuitVer...

(QB_NEW_EN_HYPHEN)

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

In `@docs/chapter1/2keyfeatures.md` at line 22, The sentence in the "Customize
input attributes of circuit components" paragraph uses "system level components"
without a hyphen; update that phrase to "system-level components" to match the
compound-adjective hyphenation used elsewhere (locate the sentence starting with
"CircuitVerse includes a vast library..." and replace "system level components"
with "system-level components").

- **Design supports multibit wires (buses)**: Every input and output circuit element has a bit width associated with it. Most of the CircuitVerse components include attributes allowing you to customize the bit widths of their inputs and outputs. CircuitVerse supports multibit wires across two components demanding multi bit widths. As needed, splitters can also be used to direct bits in different directions.
- **Design supports multibit wires (buses)**: Every input and output circuit element has a bit width associated with it. Most of the CircuitVerse components include attributes allowing you to customize the bit widths of their inputs and outputs. CircuitVerse supports multibit wires across two components demanding multi-bit widths. As needed, splitters can also be used to direct bits in different directions.

3. **Insert subcircuit**: Hierarchical circuits can be created by nesting and reusing smaller circuits in larger circuits (something like this). No need to mention verilog here.
3. **Insert subcircuits**: Hierarchical circuits can be created by nesting and reusing smaller circuits in larger circuits.

4. **Export images in multiple formats**: High-resolution CircuitVerse images can be exported in multiple formats for different views and background options.

5. **Visualize circuit simulations using timing diagram**: Timing diagrams can be used to analyze and debug the behavior of circuits for different input sequences. debug logical mistakes and race conditions. Timing diagrams can be paired with the Flag circuit element to explain different concepts such as propagation delay, stable state and race conditions.
5. **Visualize circuit simulations using timing diagrams**: Timing diagrams can be used to analyze and debug the behavior of circuits for different input sequences. Debug logical mistakes and race conditions. Timing diagrams can be paired with the Flag circuit element to explain different concepts such as propagation delay, stable state and race conditions.

6. **Embed simulations across webpages and presentations**: Since the CircuitVerse webpages are structured using HTML5, an iframe can be generated for embedding each CircuitVerse simulation within web pages. Alternatively, users can download the CircuitVerse Chrome extension for embedding live CircuitVerse circuits within a Google Slides presentation.

Expand Down
2 changes: 1 addition & 1 deletion docs/chapter1/3systemrequirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ In order to access CircuitVerse simulations on a Mac or a PC, you will need a br

> NOTE: Since CircuitVerse is built in HTML5, browsers do not require Flash Player or JavaScript to load the CircuitVerse simulator.

Additionally, CircuitVerse does not support touch screen devices or mobile browsers for any device.
Additionally, CircuitVerse does not support touchscreen devices or mobile browsers for any device.
5 changes: 4 additions & 1 deletion netlify.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
[build]
#Directory to publish
publish = "build/"
command = "npm run build"
command = "npm ci && npm run build"

[build.environment]
NODE_VERSION = "18"
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.

⚠️ Potential issue | 🟠 Major

NODE_VERSION = "18" is past end-of-life — upgrade to Node 20 or 22.

Node.js 18 transitioned to Maintenance mode in October 2023 and reached end-of-life on April 30, 2025, after which it no longer receives security updates or maintenance releases. We're currently in February 2026, so this build environment runs on an unsupported, unpatched runtime. The current Active LTS version is Node.js 22.x (as of July 2025).

⬆️ Proposed fix
 [build.environment]
-  NODE_VERSION = "18"
+  NODE_VERSION = "22"
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
NODE_VERSION = "18"
[build.environment]
NODE_VERSION = "22"
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@netlify.toml` at line 7, Update the NODE_VERSION setting from "18" to a
currently supported LTS like "22" by changing the NODE_VERSION = "18" entry to
NODE_VERSION = "22" so the build environment uses Node.js 22.x; ensure any
CI/build scripts that rely on NODE_VERSION also accept the new value (search for
the NODE_VERSION symbol to locate usages).


23 changes: 23 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.