Contrib.social

README.md needs to be updated

Open on Drupal.org →
Created on 31 January 2025, 3 months ago

Problem/Motivation

At the moment the readme.md says

How to create a quiz
Create a basic quiz by going to Create content > Quiz. You will have the opportunity to set many options if you would like.
Finally, add questions to the quiz by clicking the "Quiz" tab and then "Manage questions". Here you can create a new question, or use the question bank to add a previously used question.
After adding questions, click the "Take" tab to take the Quiz!

This is incorrect.

Steps to reproduce

  1. Install the module and search for the README.md
  2. Read it

Proposed resolution

Write this instead:

How to create a quiz
Quiz should add a new menu item to your admin menu called Quiz. 
Go to Quiz > Quiz (/admin/quiz/quizzes) and add a quiz.
Go to the Questions tab and add questions to the quiz.
Go to the Take Quiz tab and take the quiz.

Remaining tasks

Update the README.md... And do let this How to create a quiz/Get started bit show up on the module page.

A good ewxample: The Wayback Filter module → has Installation and configuration for both 7 and 8+ versions that'll help people to quickly decide
a) if they should bother installing the module and
b) get up and running quickly, should they install it.

Navigating to a README.md file on the server is not particularly hard, nor user friendly.
Keeping the online documentation up to date is very, very useful.

🐛 Bug report
Status

Active

Version

7.0

Component

Documentation

Created by

🇩🇰Denmark Steven Snedker

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024