microsoft / microsoft/generative-ai-with-javascript
feat/idea: improve quiz experience by hiding answers in README
Nobody has claimed this yet.
- 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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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
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