Skip to content

added verilog docs #438

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.

Sign up for GitHub

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
092vk wants to merge 2 commits into
base: master
Choose a base branch
from
Open

added verilog docs #438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e846ca
added verilog docs
092vk Aug 27, 2025
c0fcb56
added mdx files
092vk Aug 29, 2025
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
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,15 @@ cd CircuitVerseDocs

## Local Deployment for testing

### Docusaurus
To start the Docusaurus server:
```sh
npm install
npm start
```

### Docsify

To view the docs in offline mode, navigate to `/docs` folder and run
`python3 -m http.server` (for python3.x) or
`python -m SimpleHTTPServer 8000` (for python2.x) or
Expand Down
2 changes: 1 addition & 1 deletion docs/chapter8/1onlineforums.mdx → docs/chapter9/1onlineforums.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: chapter8-onlineforums
id: chapter9-onlineforums
title: "Onlineforums"
description: "Onlineforums page in Chapter8 of CircuitVerse documentation."
---
Expand Down
2 changes: 1 addition & 1 deletion docs/chapter8/2cvfaq.mdx → docs/chapter9/2cvfaq.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: chapter8-cvfaq
id: chapter9-cvfaq
title: "Cvfaq"
description: "Cvfaq page in Chapter8 of CircuitVerse documentation."
---
Expand Down
2 changes: 1 addition & 1 deletion docs/chapter8/3cverrormessages.mdx → docs/chapter9/3cverrormessages.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: chapter8-cverrormessages
id: chapter9-cverrormessages
title: "Cverrormessages"
description: "Cverrormessages page in Chapter8 of CircuitVerse documentation."
---
Expand Down
2 changes: 1 addition & 1 deletion docs/chapter8/4shortcuts.mdx → docs/chapter9/4shortcuts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: chapter8-shortcuts
id: chapter9-shortcuts
title: "Shortcuts"
description: "Shortcuts page in Chapter8 of CircuitVerse documentation."
---
Expand Down
18 changes: 13 additions & 5 deletions sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,12 +81,20 @@ const sidebars = {
},
{
type: 'category',
label: 'Chapter 8: Support Resources',
label: 'Chapter 8: Verilog Support',
items: [
{ type: 'doc', id: 'chapter8/chapter8-onlineforums', label: 'Online Forums' },
{ type: 'doc', id: 'chapter8/chapter8-cvfaq', label: 'FAQ' },
{ type: 'doc', id: 'chapter8/chapter8-cverrormessages', label: 'Understanding Error Messages' },
{ type: 'doc', id: 'chapter8/chapter8-shortcuts', label: 'Keyboard Shortcuts' },
{ type: 'doc', id: 'chapter8/1circuittoverilog', label: 'Circuit to Verilog' },
{ type: 'doc', id: 'chapter8/2verilogtocircuit', label: 'Verilog to Circuit' },
],
Comment thread
092vk marked this conversation as resolved.
},
{
type: 'category',
label: 'Chapter 9: Support Resources',
items: [
{ type: 'doc', id: 'chapter9/1onlineforums', label: 'Online Forums' },
{ type: 'doc', id: 'chapter9/2cvfaq', label: 'FAQ' },
{ type: 'doc', id: 'chapter9/3cverrormessages', label: 'Understanding Error Messages' },
{ type: 'doc', id: 'chapter9/4shortcuts', label: 'Keyboard Shortcuts' },
],
},
],
Expand Down