Refined Key Features Section for Better Readability and Professionalism #396
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ThatDeparted2061
suggested changes
Feb 27, 2025
docs/chapter1/2keyfeatures.md
Outdated
|
|
||
| 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. | ||
|
|
||
| 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 diagram**: Timing diagrams can be used to analyze and the behavior of circuits for different input sequences. To 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. |
There was a problem hiding this comment.
You forgot a debug here
There was a problem hiding this comment.
This whole paragraph needs improvement , gramatically correct but broken.
Take documentation suggestions from gpt
docs/chapter1/2keyfeatures.md
Outdated
|
|
||
| 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. | ||
| - **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. | ||
| - **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 multibit widths. As needed, splitters can also be used to direct bits in different directions. |
| @@ -6,19 +6,19 @@ This section shares key features of the CircuitVerse simulator. | |||
|
|
|||
| <div align="center"><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). | |||
|
@ThatDeparted2061 Have made the required changes .PTAL |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #388
Changes done:
Typographical Errors:
Corrected "operating system dependent instructions" to "operating-system-dependent instructions."
Updated "demanding multi bit widths" to "demanding multibit widths."
Grammatical Errors:
Modified "debug logical mistakes and race conditions" to "to debug logical mistakes and race conditions."
✅️ By submitting this PR, I have verified the following