microsoft / microsoft/generative-ai-with-javascript

feat/idea: improve quiz experience by hiding answers in README

Open
#21 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
JavaScript
Stars
1.3k
Forks
841
Avg merge
1d 3h
Merged PRs (30d)
1

Description

To make the learning experience more engaging without requiring external tools or issue tracking, we can enhance the quiz section in the README by hiding the correct answer inside a collapsible Markdown block (<details> tag).

This allows users to attempt the quiz before revealing the correct answer, keeping the experience interactive and self-contained within GitHub.


✅ Proposed Solution
1️⃣ Update the Quiz Format in README
  • Use Markdown collapsible blocks (<details>...</details>) to hide the correct answer so users can try answering before revealing it.

  • Example update in README:

## 🧩 Quick Challenge!  
What was the main architectural challenge that Dinocrates faced?  

- [ ] Lack of materials  
- [ ] Navigation issues near the coast  
- [ ] Political instability  

<details>
  <summary>💡 Click to Reveal Answer</summary>
  ✅ **Correct answer:** Navigation issues near the coast.
</details>

Impact:

🔹 Users engage with the quiz before checking the answer.
🔹 No need for external issue tracking or GitHub Actions.
🔹 Simple and fully compatible with GitHub Markdown.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the repository README and locate the quiz section described in the issue. Convert the quiz answer into a collapsible

block with a summary, then verify that the question and choices remain visible while the answer is revealed only when expanded.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.