Skip to content
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

To add some new pop quizzes to the various topics in the book #505

Closed
14 of 51 tasks
ayan-biswas0412 opened this issue Feb 14, 2021 · 39 comments · Fixed by #506, #512, #522, #521 or #517
Closed
14 of 51 tasks

To add some new pop quizzes to the various topics in the book #505

ayan-biswas0412 opened this issue Feb 14, 2021 · 39 comments · Fixed by #506, #512, #522, #521 or #517
Labels
documentation related to textual content Easy good first issue Good for newcomers

Comments

@ayan-biswas0412
Copy link
Member

ayan-biswas0412 commented Feb 14, 2021

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

The objective of this feature is to provide the users a interactive quiz to understand the topics more concisely there is a already issue on this topic but there is not written that all the PRs related to it should point to the master branch and this is the main problem

Describe the solution you'd like

by using the method given in the readme like below all the question answers has to be written in the interactive book.

example:

{:.quiz}
1. Example question
	1. Correct answer
	* Incorrect answer
2. What is 1 + 1?
	* 1
	1. 2	
   	* 3

Note that answers must be text only and not contain any other formatting.

Additional context

Actually I am already working on this issue and after seeing other PR's #501 and #502 I saw the reviews on them and both have got immense merge conflicts so I have opened this issue . I have also done the previous thing and currently I have reworked on my PR so for the future developers I opened this to refrain them from rework

before start working comment below in this format and constantly update the comment after you submit a new PR

### My Active PRs till now in this issue 

#PR_number  : quiz_file_name.md

### Currently working on
quiz_file_name.md

cc @ayan-biswas0412

Checklist of the Entire Pop-Quizzes

If anybody is about to start working please first see the ticked ones and then start with non ticked files

docs/binary-algebra

  • addition.md
  • boolean-algebra.md
  • boolean-functions.md
  • division.md
  • ieee-std-754.md
  • multiplication.md
  • shannon.md
  • subtraction.md

docs/binary-representation

  • binary-numbers.md
  • discrete-quantities.md
  • encoding-information.md
  • negative-quantities.md
  • number-bases.md

docs/comb-lsi

  • alu.md
  • plds.md
  • rom.md

docs/comb-msi

  • adders.md
  • encoders-decoders.md
  • mux-demux.md
  • mux-functions.md

docs/comb-ssi

docs/logic-design

docs/seq-design

docs/seq-lsi

  • fpga.md
  • microprocessors.md
  • rom-microcontrollers.md

docs/seq-msi

  • counters.md
  • msi-seq-design.md
  • mult-div.md
  • registers.md

docs/seq-ssi

  • asynchronous-systems.md
  • clock-signals.md
  • flip-flops.md
  • latches.md
  • synchronous-systems.md
  • time-diagrams.md

in order to avoid collisions, just add a comment regarding the topic you are working on

Make sure that you mention it in PR Don't write Fixes or Closes

And to ensure fair opportunity to everyone, work on no more than one topic at one time.(i.e. one checkbox)

@ayan-biswas0412
Copy link
Member Author

@saumyasrivastava08 @Samridhi-98 @ritik307 please see this and add your thoughts
please add your views also @Shivansh2407

@Shivansh2407
Copy link
Member

@ayan-biswas0412 great work! This will keep all the PRs related to Pop quiz in one place. Could you please update the issue, including a checklist with all the pages present in the Updated Book (GSOD 2020 Branch), and we'll check off the pages for which the PRs have been made so that it is easy for the contributors to figure out the left out pages which do not have pop quiz.

@ayan-biswas0412
Copy link
Member Author

@ayan-biswas0412 great work! This will keep all the PRs related to Pop quiz in one place. Could you please update the issue, including a checklist with all the pages present in the Updated Book (GSOD 2020 Branch), and we'll check off the pages for which the PRs have been made so that it is easy for the contributors to figure out the left out pages which do not have pop quiz.

yah sure I will definitely do that .

@ayan-biswas0412
Copy link
Member Author

@Shivansh2407 please see the checklist above I have updated that and please review my PRs 🥳

@ayan-biswas0412
Copy link
Member Author

ayan-biswas0412 commented Feb 15, 2021

@ayan-biswas0412 great work! This will keep all the PRs related to Pop quiz in one place. Could you please update the issue, including a checklist with all the pages present in the Updated Book (GSOD 2020 Branch), and we'll check off the pages for which the PRs have been made so that it is easy for the contributors to figure out the left out pages which do not have pop quiz.

as this issue is very big can you pin this issue for greater visibility ? @Shivansh2407

@ayan-biswas0412
Copy link
Member Author

currently I am working on the mux-functions.md I will add PR soon

@ayan-biswas0412
Copy link
Member Author

ayan-biswas0412 commented Feb 15, 2021

My Active PRs till now in this issue

#510 : mux-functions.md
#509 : mux-demux.md
#506 : negative-quantities.md
#512 : encoders-decoders.md
#515 : adders.md

Currently working on

asynchronous-systems.md
flip-flops.md

cc @Shivansh2407 @SamriddhiMishra @ritik307

@Shivansh2407
Copy link
Member

I would like to get your views on introducing a Question Bank sort of System that fetches Random questions everytime the page loads. This way, the user will get different questions and will not make it predictable for the users. You can continue to work on the PRs, we can update the Pop quiz later when this System is completely built.
Let me know your views on this @satu0king.

@Shivansh2407
Copy link
Member

This is to inform everyone who all are working on the PRs related to this issue (Pop Quizzes), make sure that the Questions you include in the Quiz are not directly from any website. We have transformed the Interactive Book during the Season of Docs and it is free of plagiarism. By introducing replicated questions from different websites in the Pop quizzes, we do not want to break the rules. You can always produce questions or take reference from the web for more help !
Keep Contributing 🎉

@manjotsidhu
Copy link
Member

manjotsidhu commented Feb 21, 2021

I would like to get your views on introducing a Question Bank sort of System that fetches Random questions everytime the page loads. This way, the user will get different questions and will not make it predictable for the users. You can continue to work on the PRs, we can update the Pop quiz later when this System is completely built.
Let me know your views on this @satu0king.

Question Bank looks like a great idea but how you are looking to group them ? I would prefer to be grouped according to chapter and tagged for associated target section. In this way, while reading the chapters from difficulty level 0 to 2 (top-down), the question bank will include the ones which were also targeted to the previous sections and randomizes the questions to test the thorough revision of the chapter.

@Samridhi-98
Copy link
Contributor

Samridhi-98 commented Feb 21, 2021

Currently working on :

  • fpga.md
  • microprocessors.md
  • rom-microcontrollers.md

CC: @Shivansh2407

@ritik307
Copy link
Contributor

@Shivansh2407 @ayan-biswas0412 Currently working on flow-diagrams , fsm and race-conditions.

@Shivansh2407
Copy link
Member

Hey Everyone, Great job 🎉 You all have been making a lot of PRs, and you need not to worry as I will be reviewing them soon. I was thinking to implement a Question Bank System as mentioned earlier that will benefit us in the long run. From a user point of view, one would not expect to answer same questions everytime, that is being done using pop quizzes which are static and shows fixed questions. We need some random questions from a large pool for each chapter! This is a large project and requires a plan before implementation. Please let me know your views and we can discuss more on this.

@ayan-biswas0412
Copy link
Member Author

ayan-biswas0412 commented Feb 23, 2021

@Shivansh2407 I totally agree with you but I think for that we can plan a rough flow like this => for now we can accept questions from the developers as PRs like what we are doing currently and when a particular page will reach certain number of questions say (approxx 30 questions) then we can randomly show 5 questions and hide rest of them.
Now the question base will enlarge by contribution from all the developers and based on that randomisation will work more aptly

@Samridhi-98
Copy link
Contributor

@Shivansh2407 Totally agree with your idea we should implement something like a question bank to provide a variety to the users to boost up their knowledge by solving different questions on a particular topic.

@manjotsidhu
Copy link
Member

Hey Everyone, Great job 🎉 You all have been making a lot of PRs, and you need not to worry as I will be reviewing them soon. I was thinking to implement a Question Bank System as mentioned earlier that will benefit us in the long run. From a user point of view, one would not expect to answer same questions everytime, that is being done using pop quizzes which are static and shows fixed questions. We need some random questions from a large pool for each chapter! This is a large project and requires a plan before implementation. Please let me know your views and we can discuss more on this.

We should focus on collection of questions first and then we can eventually build up the system later on. We can collect questions in a sofisticated data structure in some kind of database to make this happen. Another task would be adding already deployed quizes to that database.

The database can be made up of JSON, YML or even using online tools like Google Sheets, Google Form etc.

@ritik307
Copy link
Contributor

@Shivansh2407 Yes, I also do think so that we should add a number of questions for each topic to provide a clear understanding of the topics.

manjotsidhu added a commit that referenced this issue May 22, 2021
* added pop quiz to doc/binary-algebra
* updated all questions in docs/binary-algebra
* added pop quiz seq-design/flow-diagram
* removed accidently added  ques
* added popquiz for seq-diagrams/flow-diagrams
* added popquiz for seq-diagrams/flow-diagrams
* added popquiz for seq-diagrams/flow-diagrams
* Update flow-diagrams.md
Changed all lowercase character to uppercase in options
* Fixed the typo
* Update boolean-functions.md
* Update boolean-functions.md
* Update division.md
* Update division.md
* Cleanups

Co-authored-by: Manjot Sidhu <[email protected]>
@manjotsidhu manjotsidhu reopened this May 22, 2021
manjotsidhu pushed a commit that referenced this issue May 22, 2021
* added quiz to seq-design/race-condition
@manjotsidhu manjotsidhu added Easy good first issue Good for newcomers labels May 22, 2021
@manjotsidhu manjotsidhu pinned this issue May 30, 2021
@marshalmiller
Copy link
Contributor

I would like to contribute to this for OSD.

@marshalmiller
Copy link
Contributor

My Active PRs till now in this issue 1

#PR_number : 560

Currently working on

binary-cubes.md

cc @ayan-biswas0412

marshalmiller added a commit to marshalmiller/Interactive-Book that referenced this issue Jul 15, 2021
Rephrased binary-cubes.md quiz questions as requested. Addresses CircuitVerse#505.
@Shivansh2407 Shivansh2407 reopened this Jul 15, 2021
@induviduality
Copy link
Contributor

induviduality commented Jul 15, 2021

My Active PRs till now in this issue

None

Currently working on

alu.md

cc @ayan-biswas0412

@manjotsidhu
Copy link
Member

manjotsidhu commented Jul 22, 2021

I realized that we don't have guidelines and example for writing pop quizzes in Contributing Guidelines. Someone kindly take this up and add those things from this Issue and README.md and file a Pull Request.

@Palaksharma23
Copy link
Member

i would love to work on this issue , can i take this up ?

@ZaidKhan2002
Copy link
Contributor

My Active PRs till now in this issue

None

Currently working on

latches.md

cc @ayan-biswas0412

@ZaidKhan2002 ZaidKhan2002 mentioned this issue Feb 1, 2022
3 tasks
@Snehagupta1907
Copy link

I would love to work on this issue, can I take this up?

@ayan-biswas0412
Copy link
Member Author

I would love to work on this issue, can I take this up?

go ahead

@ZaidKhan2002
Copy link
Contributor

ZaidKhan2002 commented Feb 5, 2022

My Active PRs till now in this issue

latches.md

Currently working on

flipflops.md

cc @ayan-biswas0412

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment