-
Notifications
You must be signed in to change notification settings - Fork 310
Docs/updates: Improve technical accuracy and clarity of Verilog documentation #533
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
SouparnaChatterjee
wants to merge
21
commits into
CircuitVerse:master
Choose a base branch
from
SouparnaChatterjee:docs/updates
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
1d09461
Update 1introduction.md
SouparnaChatterjee 268b043
Update 1introduction.md
SouparnaChatterjee ae2e84b
Update 1introduction.md
SouparnaChatterjee 563acf7
Update 1introduction.md
SouparnaChatterjee 216077c
Update 1introduction.md
SouparnaChatterjee 3fc5d1f
Update 1introduction.md
SouparnaChatterjee 1243c9b
Update 1introduction.md
SouparnaChatterjee 00351bf
Update 1introduction.md
SouparnaChatterjee 93e6708
Update 1introduction.md
SouparnaChatterjee d1a48cf
Update and rename 1introduction.md to 1introduction.mdx
SouparnaChatterjee 7e233cc
Update 1introduction.mdx
SouparnaChatterjee 05b35c3
Update 1introduction.mdx
SouparnaChatterjee e3fdd25
Update 1introduction.mdx
SouparnaChatterjee 6af8fa2
Update 1introduction.mdx
SouparnaChatterjee 321b9b8
Fix: Make iframes responsive below 650px using global CSS media query…
naman79820 e6d059d
Fix: Use semantic figcaption for figure captions (MD036 compliance)
SouparnaChatterjee 992b1b8
Merge remote changes
SouparnaChatterjee 10b35aa
Fix: Remove merge conflict markers from custom.css
SouparnaChatterjee e3419dd
Your commit message
SouparnaChatterjee db832b9
updated
SouparnaChatterjee a2f1095
fix(docs): remove duplicate introduction.md causing Docusaurus id/slu…
SouparnaChatterjee File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| --- | ||
| id: chapter1-introduction | ||
| title: "Introduction" | ||
| description: "Introduction to CircuitVerse and its features." | ||
| slug: / | ||
| --- | ||
|
|
||
| ## What is CircuitVerse? | ||
|
|
||
| Inspired by Logisim, **CircuitVerse** is an open-source educational platform for designing and visualizing digital logic circuits directly in the browser. It enables educators, students, electronics engineers, and hobbyists to experiment with digital circuit simulations and explore various "what-if" scenarios. | ||
|
|
||
| Users can share their creations using unique circuit URLs or fork projects from the CircuitVerse community to satisfy their curiosity. | ||
|
|
||
|  | ||
|
|
||
| *Figure 1.1: Ripple Carry Adder simulation built using CircuitVerse* | ||
|
|
||
| <hr /> | ||
|
|
||
| ## Classroom Management | ||
|
|
||
| Developed for educators by educators, CircuitVerse delivers a **high-quality learning experience** at scale. Educators can: | ||
|
|
||
| - Create and manage student groups | ||
| - Assign projects with deadlines | ||
| - Track submissions and export grades | ||
|
|
||
| Using the CircuitVerse Chrome extension, instructors can embed live circuits into Google Slides or export simulations as images or iFrames. | ||
|
|
||
|  | ||
|
|
||
| *Figure 1.2: Classroom management features in CircuitVerse* | ||
|
|
||
| <hr /> | ||
|
|
||
| ## Community & Collaboration | ||
|
|
||
| As the CircuitVerse community grows, educators and students can connect through online forums to share ideas, ask questions, and collaborate on digital logic design concepts. | ||
|
|
||
|  | ||
|
|
||
| *Figure 1.3: CircuitVerse community forum* | ||
|
|
||
| <hr /> | ||
|
|
||
| ## Video Overview | ||
|
|
||
| Watch the video below for a quick demonstration of the CircuitVerse platform: | ||
|
|
||
| <iframe | ||
| width="100%" | ||
| height="400" | ||
| src="https://www.youtube.com/embed/3Df-2Cn_80A" | ||
| title="CircuitVerse Platform Overview" | ||
| loading="lazy" | ||
| allowFullScreen | ||
| /> | ||
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -45,6 +45,6 @@ | |
| ] | ||
| }, | ||
| "engines": { | ||
| "node": ">=18.0" | ||
| "node": ">=18" | ||
| } | ||
| } | ||
This file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.