migrated the website to Docusaurus #386

salmoneatenbybear · 2024-11-19T17:44:17Z

Fixes #383

Changes done:

Migrated documentation from Docsify to Docusaurus.
Updated the entire structure of the documentation to align with Docusaurus' default structure for better maintainability and SEO.
Included the new Docusaurus configuration and removed existing Docsify-specific files.
Implemented the new search feature using @easyops-cn/docusaurus-search-local.

Screenshots:

Since this is a major structural and styling migration, please refer to the video demonstration showcasing the updated website here:

New.Docusaurus.Website.mp4

Preview Link(s):

Updated Docusaurus documentation website

PLEASE NOTE THAT THE PREVIEW LINK IS PUBLISHING FROM A REPO I MADE FOR TESTING THIS SITE ONCE EVERYTHING IS APPROVED THIS NEEDS TO BE CHANGED TO BE PUBLISHING FROM THIS REPO.

✅️ By submitting this PR, I have verified the following

Checked to see if a similar PR has already been opened 🤔️
Reviewed the contributing guidelines 🔍️
Sample preview link added (add a link from the checks tab after checks complete)
Tried squashing the commits into one

salmoneatenbybear · 2024-11-19T17:48:59Z

@tachyons please review once you are free :)

ThatDeparted2061

I am guessing since the data is directly from the current docs, reviewing the configs should be enough to get this running.

SharonIV0x86 · 2025-01-21T18:37:51Z

CircuitVerse-Documentation/docs/chapter4/6sequentialelements.mdx

+
+## Clock
+
+The **Clock **circuit element toggles its output at regular time intervals.


Suggested change

The **Clock **circuit element toggles its output at regular time intervals.

The **Clock** circuit element toggles its output at regular time intervals.

SharonIV0x86 · 2025-01-21T18:38:06Z

CircuitVerse-Documentation/docs/chapter4/6sequentialelements.mdx

+
+## ROM
+
+As the name suggests, the **ROM **( read-only memory) circuit element stores read only data for computers and other electronic devices. ROM is mostly used for firmware updates. A simple example of ROM is the cartridge used with video game consoles, which allows one system to run multiple games. Another example of ROM is EEPROM, which is a programmable ROM used for the computer BIOS.


Suggested change

As the name suggests, the **ROM **( read-only memory) circuit element stores read only data for computers and other electronic devices. ROM is mostly used for firmware updates. A simple example of ROM is the cartridge used with video game consoles, which allows one system to run multiple games. Another example of ROM is EEPROM, which is a programmable ROM used for the computer BIOS.

As the name suggests, the **ROM** ( read-only memory) circuit element stores read only data for computers and other electronic devices. ROM is mostly used for firmware updates. A simple example of ROM is the cartridge used with video game consoles, which allows one system to run multiple games. Another example of ROM is EEPROM, which is a programmable ROM used for the computer BIOS.

SharonIV0x86 · 2025-01-21T18:38:51Z

CircuitVerse-Documentation/docs/chapter4/6sequentialelements.mdx

+  </em>
+</div>
+
+You can verify the behavior of the **RAM **circuit element in the live circuit embedded below:


Suggested change

You can verify the behavior of the **RAM **circuit element in the live circuit embedded below:

You can verify the behavior of the **RAM** circuit element in the live circuit embedded below:

SharonIV0x86

These sections:

RAM
ROM
Clock
Have incorrectly placed * for bold formatting which needs to be fixed.

SharonIV0x86 · 2025-01-21T18:44:35Z

@salmoneatenbybear A few diagrams in Chapter 4 have black text on them, when switched to dark mode these images are barely visible here

ManishG04 · 2025-01-21T18:49:40Z

CircuitVerse-Documentation/docs/chapter5/usingeditlayout.mdx

@@ -0,0 +1,66 @@
+---
+id: chapter5-usingeditlayout
+title: "Usingeditlayout"


Suggested change

title: "Usingeditlayout"

title: "Using Edit Layout"

ManishG04 · 2025-01-21T18:50:27Z

CircuitVerse-Documentation/docs/chapter5/usingsubcircuits.mdx

@@ -0,0 +1,30 @@
+---
+id: chapter5-usingsubcircuits
+title: "Usingsubcircuits"


Suggested change

title: "Usingsubcircuits"

title: "Using Sub-Circuits"

ManishG04

@salmoneatenbybear Almost all chapter titles have spacing issues in frontmatter

ManishG04 · 2025-01-21T19:03:02Z

CircuitVerse-Documentation/docs/chapter2/2cvforeducators.mdx

+
+Watch the below video for a quick demonstration of how the CircuitVerse Chrome extension works in Google Slides.
+
+[insert embed video]


Video needs to be inserted here

SharonIV0x86 · 2025-01-21T19:04:16Z

CircuitVerse-Documentation/docs/chapter7/2buildwithcv.mdx

+     <em>Figure 7.3</em>
+   </div>
+
+   Watch this video for more information on the different fields that can be used for sharing more information about the project.


Video is not listed.

SharonIV0x86 · 2025-01-21T19:08:53Z

CircuitVerse-Documentation/docs/chapter4/3output.mdx

+
+## HexDisplay
+
+The **HexDisplay** is more simple to use than the** SevenSegDisplay** and **SixteenSegDisplay **circuit elements. Since it takes a 4-bit input and can display integers 1 through 9 and the letters A through F, there is less room for customization.


Suggested change

The **HexDisplay** is more simple to use than the** SevenSegDisplay** and **SixteenSegDisplay **circuit elements. Since it takes a 4-bit input and can display integers 1 through 9 and the letters A through F, there is less room for customization.

The **HexDisplay** is more simple to use than the **SevenSegDisplay** and **SixteenSegDisplay** circuit elements. Since it takes a 4-bit input and can display integers 1 through 9 and the letters A through F, there is less room for customization.

SharonIV0x86 · 2025-01-21T19:12:23Z

CircuitVerse-Documentation/docs/chapter4/6sequentialelements.mdx

+
+The **D Latch** circuit element is a single input flip flop. As Figure 4.4, it works similar to a **D Flip Flop** but it does not include the preset, asynchronous and enable signal pins. The truth table of a D Latch (refer Table 4.13) is similar to that of the D Flip Flop.
+
+> Properties that can be customized in the **PROPERTIES** panel include:\*\* **BitWidth**


This is not rendering properly additional ** are visible.

ManishG04 · 2025-01-21T19:13:30Z

CircuitVerse-Documentation/docs/chapter4/8misc.mdx

+
+## Adder
+
+The **Adder** circuit element is a logical circuit of a full adder that performs an addition operation on binary numbers and produces a sum of the three inputs and a carry value (Cout). Figure 4.18 displays the different pins available for the **Adder **circuit element within CircuitVerse and Table 4.21 shares a brief description of the same.


Suggested change

The **Adder** circuit element is a logical circuit of a full adder that performs an addition operation on binary numbers and produces a sum of the three inputs and a carry value (Cout). Figure 4.18 displays the different pins available for the **Adder **circuit element within CircuitVerse and Table 4.21 shares a brief description of the same.

The **Adder** circuit element is a logical circuit of a full adder that performs an addition operation on binary numbers and produces a sum of the three inputs and a carry value (Cout). Figure 4.18 displays the different pins available for the **Adder** circuit element within CircuitVerse and Table 4.21 shares a brief description of the same.

ManishG04 · 2025-01-21T19:13:40Z

CircuitVerse-Documentation/docs/chapter4/7annotation.mdx

+
+The **Text** annotation element allows users to add multi-line text to share more information about the live circuit––circuit logic design details of the circuit, expected behavior of the circuit, etc.. Refer Figure 4.14.
+
+> Properties that can be customized in the **PROPERTIES** panel include:\*\* **Font size**


Suggested change

> Properties that can be customized in the **PROPERTIES** panel include:\*\* **Font size**

> Properties that can be customized in the **PROPERTIES** panel include: **Font size**

ManishG04 · 2025-01-21T19:14:09Z

CircuitVerse-Documentation/docs/chapter2/3lmsintegration.mdx

+## Generating configuration credentials
+
+1. Login to CircuitVerse account and go to the corresponding Group in which you want to create an assignment.
+2. Click on the **+Add Assignment** button.


Suggested change

2. Click on the **+Add Assignment** button.

2. Click on the **+ Add Assignment** button.

ManishG04 · 2025-01-21T19:14:17Z

CircuitVerse-Documentation/docs/chapter2/3lmsintegration.mdx

+3. In the left sidebar, click **Settings**.
+4. Click the **Apps** tab.
+5. Click **View app configurations**.
+6. Click **+App**.


Suggested change

6. Click **+App**.

6. Click **+ App**.

ManishG04 · 2025-01-21T19:16:02Z

CircuitVerse-Documentation/docs/chapter4/8misc.mdx

+
+The **Flag** circuit element is used in a circuit design to flag outputs at different points in your circuit. Figure X highlights the different attributes that are available for this circuit element.
+
+> Properties that can be customized in the **PROPERTIES** panel include**: **BitWidth, Orientation, Debug Flag identifier\*\*


Suggested change

> Properties that can be customized in the **PROPERTIES** panel include**: **BitWidth, Orientation, Debug Flag identifier\*\*

> Properties that can be customized in the **PROPERTIES** panel include: **BitWidth, Orientation, Debug Flag identifier**

ManishG04

@salmoneatenbybear These are some problems I found

salmoneatenbybear · 2025-01-22T01:07:52Z

@SharonIV0x86 @ManishG04 @ThatDeparted2061

Thanks for taking the time to find these issues

Please check out the repo for this site

https://github.com/salmoneatenbybear/circuitverse-docs

Please could you guys create issues for this there and then we can take it from there...

ThatDeparted2061 · 2025-01-22T02:41:15Z

@salmoneatenbybear A few diagrams in Chapter 4 have black text on them, when switched to dark mode these images are barely visible here

Great find we shud have dynamic colouring for the digram labeling for light and dark mode

SharonIV0x86 · 2025-01-22T02:55:10Z

@SharonIV0x86 @ManishG04 @ThatDeparted2061

Thanks for taking the time to find these issues

Please check out the repo for this site

https://github.com/salmoneatenbybear/circuitverse-docs

Please could you guys create issues for this there and then we can take it from there...

Alright, I'll open an issue for each of the changes.

ManishG04 · 2025-01-22T08:14:50Z

@SharonIV0x86 @ManishG04 @ThatDeparted2061

Thanks for taking the time to find these issues

Please check out the repo for this site

https://github.com/salmoneatenbybear/circuitverse-docs

Please could you guys create issues for this there and then we can take it from there...

Alright, I will be opening the issues, I accidentaly opened one issue in this repo only I closed it sorry for that I have just started Open Source

ThatDeparted2061 · 2025-01-22T10:22:23Z

@SharonIV0x86 @ManishG04 @ThatDeparted2061

Thanks for taking the time to find these issues

Please check out the repo for this site

https://github.com/salmoneatenbybear/circuitverse-docs

Please could you guys create issues for this there and then we can take it from there...

Alright, I will be opening the issues, I accidentaly opened one issue in this repo only I closed it sorry for that I have just started Open Source

It's not a problem, you re just learning. You can always close the PR.
REGARDS

migrated the website to Docusaurus

5393242

salmoneatenbybear added 2 commits November 20, 2024 11:59

made changes to mirror current dr structure

a1d0d68

Algolia Docsearch is now live

de8b4c8

ThatDeparted2061 reviewed Jan 21, 2025

View reviewed changes

SharonIV0x86 reviewed Jan 21, 2025

View reviewed changes

SharonIV0x86 suggested changes Jan 21, 2025

View reviewed changes

ManishG04 reviewed Jan 21, 2025

View reviewed changes

SharonIV0x86 reviewed Jan 21, 2025

View reviewed changes

ManishG04 reviewed Jan 21, 2025

View reviewed changes

ManishG04 suggested changes Jan 21, 2025

View reviewed changes

This was referenced Jan 22, 2025

Misplaced asterisk (*) for bold font - 4 salmoneatenbybear/circuitverse-docs#6

Closed

Additional ** are visible. salmoneatenbybear/circuitverse-docs#7

Closed

ManishG04 mentioned this pull request Jan 22, 2025

Inconsistent Spacing in frontmatter #391

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

migrated the website to Docusaurus #386

migrated the website to Docusaurus #386

salmoneatenbybear commented Nov 19, 2024 •

edited

Loading

salmoneatenbybear commented Nov 19, 2024

ThatDeparted2061 left a comment

SharonIV0x86 Jan 21, 2025

SharonIV0x86 Jan 21, 2025

SharonIV0x86 Jan 21, 2025

SharonIV0x86 left a comment

SharonIV0x86 commented Jan 21, 2025

ManishG04 Jan 21, 2025

ManishG04 Jan 21, 2025

ManishG04 left a comment

ManishG04 Jan 21, 2025

SharonIV0x86 Jan 21, 2025

SharonIV0x86 Jan 21, 2025

SharonIV0x86 Jan 21, 2025

ManishG04 Jan 21, 2025

ManishG04 Jan 21, 2025

ManishG04 Jan 21, 2025

ManishG04 Jan 21, 2025

ManishG04 Jan 21, 2025

ManishG04 left a comment

salmoneatenbybear commented Jan 22, 2025

ThatDeparted2061 commented Jan 22, 2025

SharonIV0x86 commented Jan 22, 2025

ManishG04 commented Jan 22, 2025

ThatDeparted2061 commented Jan 22, 2025


		## Clock

		The Clock circuit element toggles its output at regular time intervals.

	The Clock circuit element toggles its output at regular time intervals.
	The Clock circuit element toggles its output at regular time intervals.


		## ROM

		As the name suggests, the ROM ( read-only memory) circuit element stores read only data for computers and other electronic devices. ROM is mostly used for firmware updates. A simple example of ROM is the cartridge used with video game consoles, which allows one system to run multiple games. Another example of ROM is EEPROM, which is a programmable ROM used for the computer BIOS.

	As the name suggests, the ROM ( read-only memory) circuit element stores read only data for computers and other electronic devices. ROM is mostly used for firmware updates. A simple example of ROM is the cartridge used with video game consoles, which allows one system to run multiple games. Another example of ROM is EEPROM, which is a programmable ROM used for the computer BIOS.
	As the name suggests, the ROM ( read-only memory) circuit element stores read only data for computers and other electronic devices. ROM is mostly used for firmware updates. A simple example of ROM is the cartridge used with video game consoles, which allows one system to run multiple games. Another example of ROM is EEPROM, which is a programmable ROM used for the computer BIOS.

	You can verify the behavior of the RAM circuit element in the live circuit embedded below:
	You can verify the behavior of the RAM circuit element in the live circuit embedded below:


		Watch the below video for a quick demonstration of how the CircuitVerse Chrome extension works in Google Slides.

		[insert embed video]


		## HexDisplay

		The HexDisplay is more simple to use than the SevenSegDisplay and SixteenSegDisplay circuit elements. Since it takes a 4-bit input and can display integers 1 through 9 and the letters A through F, there is less room for customization.


		The D Latch circuit element is a single input flip flop. As Figure 4.4, it works similar to a D Flip Flop but it does not include the preset, asynchronous and enable signal pins. The truth table of a D Latch (refer Table 4.13) is similar to that of the D Flip Flop.

		> Properties that can be customized in the PROPERTIES panel include:\\ BitWidth


		## Adder

		The Adder circuit element is a logical circuit of a full adder that performs an addition operation on binary numbers and produces a sum of the three inputs and a carry value (Cout). Figure 4.18 displays the different pins available for the Adder circuit element within CircuitVerse and Table 4.21 shares a brief description of the same.


		The Text annotation element allows users to add multi-line text to share more information about the live circuit––circuit logic design details of the circuit, expected behavior of the circuit, etc.. Refer Figure 4.14.

		> Properties that can be customized in the PROPERTIES panel include:\\ Font size

	2. Click on the +Add Assignment button.
	2. Click on the + Add Assignment button.


		The Flag circuit element is used in a circuit design to flag outputs at different points in your circuit. Figure X highlights the different attributes that are available for this circuit element.

		> Properties that can be customized in the PROPERTIES panel include: BitWidth, Orientation, Debug Flag identifier\\

migrated the website to Docusaurus #386

Are you sure you want to change the base?

migrated the website to Docusaurus #386

Conversation

salmoneatenbybear commented Nov 19, 2024 • edited Loading

Changes done:

Screenshots:

Preview Link(s):

✅️ By submitting this PR, I have verified the following

salmoneatenbybear commented Nov 19, 2024

ThatDeparted2061 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SharonIV0x86 left a comment

Choose a reason for hiding this comment

SharonIV0x86 commented Jan 21, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ManishG04 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ManishG04 left a comment

Choose a reason for hiding this comment

salmoneatenbybear commented Jan 22, 2025

ThatDeparted2061 commented Jan 22, 2025

SharonIV0x86 commented Jan 22, 2025

ManishG04 commented Jan 22, 2025

ThatDeparted2061 commented Jan 22, 2025

salmoneatenbybear commented Nov 19, 2024 •

edited

Loading