circuitverse / interactive-book Goto Github PK

Is your feature request related to a problem? Please describe.
Most of the learning resources including the tutorial on the website use 0's and 1's as labels to teach students about K-map. So, the same system implemented here will be useful and convenient for everyone

Describe the solution you'd like
0's and 1's should also be displayed along with the lines around the K-map for convenience

Describe alternatives you've considered
I am planning on displaying binary numbers below the lines used to indicate the variable.

Are you working on this? (Yes/No)
Yes

$ bundle install
Traceback (most recent call last):
2: from /home/ojas/.rbenv/versions/2.5.1/bin/bundle:23:in <main>' 1: from /home/ojas/.rbenv/versions/2.5.1/lib/ruby/site_ruby/2.5.0/rubygems.rb:308:in activate_bin_path'
/home/ojas/.rbenv/versions/2.5.1/lib/ruby/site_ruby/2.5.0/rubygems.rb:289:in `find_spec_for_exe': can't find gem bundler (>= 0.a) with executable bundle (Gem::GemNotFoundException)

There are some documentation errors like

• in this there is incomplete sentence in line 67 of the code.
• Poor readability of text in Bitwise Operators subheading in Operators in Binary. That was meant to be a table as far as I understand from the code.

There can be few improvements like

• Addition of XNOR gate here as it is being used in Interactive Gates chapter
• The general convention is XNOR, and NXOR is used sometimes. It would be easy for the students to understand if it was XNOR instead for NXOR.
• The Two-Way Light Switch example can be implemented using CircuitVerse Simulator and it would be really helpful if CIrcuitVerse Simulator is used instead of the given example and keep the switch example as used here

These are minor things that can help in the long run.

• Edit on Github link
• References page
• Google Analytics Tracking

I am submitting a -

• [] Bug Report

Describe your bug/feature -

The edit link on the page redirects to the index.md page.

Current behaviour -

The Edit on Github link on the page redirects to the index page.

Steps to reproduce the behaviour-

1. Open the interactive-book.
2. Click on the Edit on Github link you will be redirected to the index.md page.

Expected behaviour -

The edit link present on the page should redirect to the main github repository of the Interactive-Book.

Bug
The Div element showing the list of subjects on the "Basic Applications" page is not configured well for the Dark mode switch and therefore the text is barely visible there. Also there is a typo present in the Page Heading itself.

Screenshots

Solutions
Improve the css of the div element by making the background dark and text to be white. Also correct the typo accordingly.

I am submitting a -

• [] Bug Report

Describe your bug/feature -

The color of the button text is not visible in dark mode.

Screenshots (if relevant) -

I am submitting a -

• [] Feature Request

Describe your bug/feature -

Detailed explanation about unsigned and signed numbers and representation of binary numbers into signed and unsigned form can be added.

Feature request:
Conversion method of
JK FLIP FLOP ->D FLIP FLOP
SR FLIP FLOP ->JK FLIP FLOP
SR FLIP FLOP->T FLIP FLOP
T FLIP FLOP ->D FLIP FLOP
with their circuit diagram can be added

Describe the bug
Whenever we change topic/refresh the dark mode toggles back to default, ie. Day mode

To Reproduce
Click Dark mode and refresh page

Expected behavior
Mode should stay as it is during a session even after changing topic or refreshing page

Suggested Solution
Saving the mode in local storage and make use of it while loading page.

Are you working on this issue? (Yes/No)
Yes

1)Ring counter
2)Johnson's counter(Twisted/switch tail ring counter)
ARE MISSING

Tags can be introduced to each and every lessons presented in the interactive book. This will not only help to understand what areas is the chapter related to but also can be used to group related chapters under a common umbrella.

Also See Also sections can be added to some lessons to suggest further reading areas.

Feature request:
There no explanation of difference between latch and flip-flop in either of latch and flip flop section

Feature request
In reference section
What ever references are written it is only in TEXT format ,make it such that when ever we click in that link of reference we redirect to that link

I am submitting a -

• [] Feature Request

Describe your bug/feature -

Currently, only one variation of multipexer and demultiplexer is shown in the book. Add other variations of the multiplexer and demultiplexer too. The section of the multiplexers and demultiplexers can be divided into sub-section to add the other variations.

3 bit& 4 bit up/down synchronous counter missing

Problem
Number of comments becomes invisible in dark mode

Solution
color: #E3E3E3

Screenshot

Are you working on this issue
No, for GCI participants under beginner-friendly

I am submitting a -

• [] Feature Request

Describe your bug/feature -

In the logic gates tutorial the tutorial for the XNOR gate is missing. Add the tutorial of XNOR gate to the section of logic gates.

I am submitting a -

• [] Bug Report

Describe your bug/feature -

The initial of button text No is in small letter.

Screenshots (if relevant) -

I am submitting a -

• [] Feature Request

Describe your bug/feature -

For now to visit a link user need to copy the link and open it in a new browser. Make all the links of references page clickable so as it should open in a new window.

I am submitting a -

• [] Bug Report

Describe your bug/feature -

The dark mode change by default on refreshing the page.

Current behaviour - Change to the dark mode and on refreshing the page the dark mode changed.

Expected behaviour - The dark mode should not change by default on refreshing the page.

Feature request:
There is no explanation of race around or racing condition of JK FLIP FLOP

Feature: UI enhancements (including color and fonts)

• Color transition in Subheading and Paragraph for better UX.
• Suggested font-family: Roboto-mono, monospace for paragraphs.
• Color for links: #00e8b3
• Color for background: #13101f
• Color for paragraph: #efc7ff

• links in the anchor tags need to be enhanced.
• Panel and Table color transition with darker background makes it look good.
• Overall UI can use material bootstrap

• A quick comparison of Ui with the present one.

References:

• Fonts: Roboto-Mono
  • Add in Html: <link href="https://fonts.googleapis.com/css?family=Roboto+Mono&display=swap" rel="stylesheet">
  • Specify in CSS: font-family: 'Roboto Mono', monospace;
• Checkout Dark themes: https://material.io/design/color/dark-theme.html
• Material Design Bootstrap: https://mdbootstrap.com/docs/jquery/components/demo/

Bug
The color of the heading and the explanation text on the "Boolean Function" doesn't change its colour in accordance to the Dark Mode switch.

Screenshots

Solution
The text colour should changed to either white or an appropriate color in the css section.

Feature request
In combination circuit
Circuit diagram of
1)full adder
2)full subtractor
Using only UNIVERSAL GATES are missing

Feature request:
3 bit&4 bit up/down ripple counter missing

Feature request:
1)3 bit Asynchronous up counter
2)4 bit Asynchronous up counter
3)3 bit Asynchronous down counter
4)4 bit Asynchronous down counter
Are missing

Current Status
https://learn.circuitverse.org/docs/flipflop2.html contains an interactive exercise on flip flops and explanation about state tables. This can be further elaborated so that a beginner can understand it.

Changes required
Improve explanation such that understanding of interactive flip flop increases.

Are you working on this issue?
No, for GCI participants under difficult

in msi components in multiplexer in circuit diagram 0 is touches to upper level box it should be in center

I am submitting a -

• [] Bug Report

Describe your bug/feature -

The digit 0 appears to override the box.

Screenshots (if relevant) -

In K (k=4) map method number given to each cell should in following order

0 1 3 2
4 5 7 6
12 13 15 14
8 9 11 10

But it is in wrong order

• _site folder is automatically generated by gh-pages, it has already been added to .gitignore but needs to removed from repo via git rm
• It is generally a good practice to not keep node_modules inside VCS. Since all the dependencies inside package.json are dev, we should be able to safely delete it from the repo. Instruction to do npm install can be added for local setups.
• .sass_cache folder is auto-generated and can be removed

In flip flop section there is only
1)SR
2)JK
3)D
4)T
FLIP FLOP are available
But MASTER-SLAVE flip flop is missing

Add following topics after Boolean function-

1. Sum of Product
2. Product of Sum
3. Minimal to Canonical Form Conversion

Explain with examples, diagrams, flow-charts etc.

You are expected to extend the content from here - https://learn.circuitverse.org/docs/bool2.html#sum-of-product-expressions-sop

I am submitting a -

• [] Feature Request

Describe your bug/feature -

Implement feature to activate the search bar onClick. No results found should also be displayed for the contents not found in the book. This feature can also be implemented with the search bar.

In logic gate section there no word saying what are universal gate and how we can use them to make all other logic gates

I am submitting
Feature request
We can also add feature like
Sign up with:LinkedIn,GitHub

Right now there is only 4 option available

Currently, the mouse pointer does not change it's state from an arrow to hand when hovered over a gate in interactive gates module

feature request
1)Bidirectional shift register
2)Universal shift register

Are missing

I am submitting a -

• [] Feature Request

Describe your bug/feature -

The types of asynchronous and synchronous is missing in the book which should be added.

Is your feature request related to a problem? Please describe.

Templates for users to fill in while submitting issues will be helpful.

Describe the solution you'd like

Issue templates for Bug Report, Feature Request while raising an issue are necessary and will help maintain uniformity

Are you working on this? (Yes/No)

No

There are no. of CSS issues in dark mode. Most of the interactive elements are not designed for dark mode so you can start working on it one by one. Moreover, the scroll bar in nav also does change its color in dark mode.

Problem
Starred/Number of Views tab unresponsive as shown in screenshot.

Changes proposed
Use media query for maintaining the width of the tab. Verify by inspection

Screenshot

Bug
The input text and the text of the button is not visible on the "Operators in Binary" page when the dark mode is switched on.

Screenshots

Solution
The css file of the page should be changed to make the background color black and the text color to be white.

I am submitting a -

• [] Feature Request

Describe your bug/feature -

Currently, the book only consists of 4 types of registers. The other two missing registers which should be added are

1. Bidirectional Shift Register
2. Universal Shift Register

I am submitting a -

• [] Feature Request

Describe your bug/feature -

The application of multiplexer and demultiplexer can be added to make the book more informative.

Bug
The buttons and the Drop down section on the "Interactive Karnaugh Map" page doesn't change with the Dark theme of the rest of the page.

Screenshots

Solution
Change the css files of the page to change the background to black.

• Edit On GitHub
• Add Disqus comments or any other alternative
• SEO
• Add Jekyll Admin
• add alu module

I am working on this

Apply shadow effect on boxes containing digital circuits when hovered by mouse.

I am submitting a -

• [] Feature Request

Describe your bug/feature -

The contributors profile can be added to the README page.