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.

Sign up for GitHub

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

Jump to bottom

[FEATURE] drop-down for FAQ #72

Closed
MaxHillebrand opened this issue Aug 5, 2019 · 1 comment · Fixed by #79
Closed

[FEATURE] drop-down for FAQ #72

MaxHillebrand opened this issue Aug 5, 2019 · 1 comment · Fixed by #79
Labels
FAQ About the FAQ help wanted Extra attention is needed question Further information is requested visual Regarding the UI of the documentation

Comments

@MaxHillebrand
Copy link
Contributor

Is there a way to add a drop down text box?

This might be useful for the FAQ. All questions are displayed in a single line, each has a drop down arrow, and when clicked it reveals the answer to the question. Somewhat similar to how the new wasabiwallet.io does the FAQ. This would make the [[toc]] obsolete.
@MaxHillebrand MaxHillebrand added help wanted Extra attention is needed question Further information is requested visual Regarding the UI of the documentation FAQ About the FAQ labels Aug 5, 2019
@dennisreimann
Copy link
Contributor

Yes, we can add something similar to the tip/warning/danger custom blocks and use the HTML details disclosure tag for the output.

dennisreimann added a commit that referenced this issue Aug 5, 2019
@dennisreimann
Add details toggles for FAQs
fdb5303 
As requested in #72 this introduces the custom block `::: details` which can be used to initially hide long-form content and first present a summary. In this case the FAQ leverage it to better structure the questions and answers and provide a better overview than the previously used table of contents.

Thoughts: Even though I really like the output, my concern about this is that we need to use a custom block for that and the authoring of the markdown does not seem intuitive. IMHO the headlines plus plaragraphs feel more natural. Feedback welcome!
Signed-off-by: Dennis Reimann <mail@dennisreimann.de>
dennisreimann added a commit that referenced this issue Aug 5, 2019
@dennisreimann
Add details toggles for FAQs
40978e7 
As requested in #72 this introduces the custom block `::: details` which can be used to initially hide long-form content and first present a summary. In this case the FAQ leverage it to better structure the questions and answers and provide a better overview than the previously used table of contents.

Thoughts: Even though I really like the output, my concern about this is that we need to use a custom block for that and the authoring of the markdown does not seem intuitive. IMHO the headlines plus plaragraphs feel more natural. Feedback welcome!

If merged, this would close #72.

Signed-off-by: Dennis Reimann <mail@dennisreimann.de>
@dennisreimann dennisreimann mentioned this issue Aug 5, 2019
Merged
dennisreimann added a commit that referenced this issue Aug 8, 2019
@dennisreimann
Add details toggles for FAQs
93c0097 
As requested in #72 this introduces the custom block `::: details` which can be used to initially hide long-form content and first present a summary. In this case the FAQ leverage it to better structure the questions and answers and provide a better overview than the previously used table of contents.

Thoughts: Even though I really like the output, my concern about this is that we need to use a custom block for that and the authoring of the markdown does not seem intuitive. IMHO the headlines plus plaragraphs feel more natural. Feedback welcome!

If merged, this would close #72.

Signed-off-by: Dennis Reimann <mail@dennisreimann.de>
dennisreimann added a commit that referenced this issue Aug 9, 2019
@dennisreimann
Add details toggles for FAQs
4e4f134 
As requested in #72 this introduces the custom block `::: details` which can be used to initially hide long-form content and first present a summary. In this case the FAQ leverage it to better structure the questions and answers and provide a better overview than the previously used table of contents.

Thoughts: Even though I really like the output, my concern about this is that we need to use a custom block for that and the authoring of the markdown does not seem intuitive. IMHO the headlines plus plaragraphs feel more natural. Feedback welcome!

If merged, this would close #72.

Signed-off-by: Dennis Reimann <mail@dennisreimann.de>
dennisreimann added a commit that referenced this issue Aug 9, 2019
@dennisreimann
Add details toggles for FAQs
e625abe 
As requested in #72 this introduces the custom block `::: details` which can be used to initially hide long-form content and first present a summary. In this case the FAQ leverage it to better structure the questions and answers and provide a better overview than the previously used table of contents.

Thoughts: Even though I really like the output, my concern about this is that we need to use a custom block for that and the authoring of the markdown does not seem intuitive. IMHO the headlines plus plaragraphs feel more natural. Feedback welcome!

If merged, this would close #72.

Signed-off-by: Dennis Reimann <mail@dennisreimann.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
FAQ About the FAQ help wanted Extra attention is needed question Further information is requested visual Regarding the UI of the documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add details toggles for FAQs WalletWasabi/WasabiDoc
2 participants
@dennisreimann @MaxHillebrand