diff --git a/README.md b/README.md index 57c819e3b..47ec46a81 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/chapter8/1onlineforums.mdx b/docs/chapter9/1onlineforums.mdx similarity index 95% rename from docs/chapter8/1onlineforums.mdx rename to docs/chapter9/1onlineforums.mdx index 4fba7ec19..c2147bd1c 100644 --- a/docs/chapter8/1onlineforums.mdx +++ b/docs/chapter9/1onlineforums.mdx @@ -1,5 +1,5 @@ --- -id: chapter8-onlineforums +id: chapter9-onlineforums title: "Onlineforums" description: "Onlineforums page in Chapter8 of CircuitVerse documentation." --- diff --git a/docs/chapter8/2cvfaq.mdx b/docs/chapter9/2cvfaq.mdx similarity index 99% rename from docs/chapter8/2cvfaq.mdx rename to docs/chapter9/2cvfaq.mdx index 1f205f448..4829b6797 100644 --- a/docs/chapter8/2cvfaq.mdx +++ b/docs/chapter9/2cvfaq.mdx @@ -1,5 +1,5 @@ --- -id: chapter8-cvfaq +id: chapter9-cvfaq title: "Cvfaq" description: "Cvfaq page in Chapter8 of CircuitVerse documentation." --- diff --git a/docs/chapter8/3cverrormessages.mdx b/docs/chapter9/3cverrormessages.mdx similarity index 98% rename from docs/chapter8/3cverrormessages.mdx rename to docs/chapter9/3cverrormessages.mdx index b8cdf1daa..5f005e4aa 100644 --- a/docs/chapter8/3cverrormessages.mdx +++ b/docs/chapter9/3cverrormessages.mdx @@ -1,5 +1,5 @@ --- -id: chapter8-cverrormessages +id: chapter9-cverrormessages title: "Cverrormessages" description: "Cverrormessages page in Chapter8 of CircuitVerse documentation." --- diff --git a/docs/chapter8/4shortcuts.mdx b/docs/chapter9/4shortcuts.mdx similarity index 98% rename from docs/chapter8/4shortcuts.mdx rename to docs/chapter9/4shortcuts.mdx index 23688ec59..46b4f7611 100644 --- a/docs/chapter8/4shortcuts.mdx +++ b/docs/chapter9/4shortcuts.mdx @@ -1,5 +1,5 @@ --- -id: chapter8-shortcuts +id: chapter9-shortcuts title: "Shortcuts" description: "Shortcuts page in Chapter8 of CircuitVerse documentation." --- diff --git a/sidebars.js b/sidebars.js index 976afbc3b..2e13f24b0 100644 --- a/sidebars.js +++ b/sidebars.js @@ -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' }, + ], + }, + { + 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' }, ], }, ],