Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Docs Request: Click to reveal code snippets #196

Open
Valcoholics opened this issue Dec 15, 2023 · 2 comments
Open

Docs Request: Click to reveal code snippets #196

Valcoholics opened this issue Dec 15, 2023 · 2 comments
Labels
base docs review To be reviewed by the Base docs team

Comments

@Valcoholics
Copy link
Contributor

Valcoholics commented Dec 15, 2023

What is the issue you are encountering with the docs?

Suggesting a modification to the lesson structure. Instead of immediately showing the expected result after instructing people to code something on their own, I propose making some of the code blocks "click to reveal." This means learners would have the option to see the solution only when they choose to, creating a more engaging and interactive learning experience.

Describe the solution you'd like to see.

There are a lot of different ways to do this but a simple solution would be a collapsible section written in markdown.

https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections#creating-a-collapsed-section

@briandoyle81CB
Copy link
Contributor

@Valcoholics this is a fantastic idea, would you like to do a PR or PR(s) to implement it?

@Martijncvv
Copy link
Contributor

Martijncvv commented Mar 3, 2024

@Valcoholics nice idea. I'm also happy to pick this one up if you're not working on it already.

edit:
Since I really liked the idea and this is a 2-month-old issue I went through all Basecamp docs and implemented the dropdown
where necessary.

Opened a PR @briandoyle81CB

PR
#339

@wbnns wbnns added base docs review To be reviewed by the Base docs team and removed state: backlog labels Dec 18, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
base docs review To be reviewed by the Base docs team
Projects
None yet
Development

No branches or pull requests

4 participants