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

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
state: backlog This is pending further review type: docs New docs or changes to existing

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

@Valcoholics Valcoholics added the type: docs New docs or changes to existing label Dec 15, 2023
@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 the state: backlog This is pending further review label Apr 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
state: backlog This is pending further review type: docs New docs or changes to existing
Projects
None yet
Development

No branches or pull requests

4 participants