-
-
Notifications
You must be signed in to change notification settings - Fork 789
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: move faq into details / spoilers #4891
Conversation
I like this idea and was thinking it while working on some of the documentation that it was getting too long to scroll effectively. Even by use of spoiler tags, I think the organization could be tidied up with sections or sub-pages, or merging into the Features section. What if we had different sub-pages for Features / FAQ? So those exist at a top level, and links to sub-pages that relate to the item in question (that could also have the spoiler tag). Instead of just 'Here's the 2 steps to enable and turn on this feature' under the Features section is "Here are all the advanced features / usage of a Cookbook and examples" That blurs the line a bit more between documenting it under Features vs 'FAQs'. If something is so frequently asked, then why isn't it just in the normal 'Features' section? That doesn't apply to everything but definitely some of whats being asked commonly should, I think, be in the normal features we want people to know about. I would love to document and detail some example scenarios (with pictures, etc) but that would make it unruly, which I think the spoiler tag is good for. But I think before that, rethinking where the data should go and if it should still be on a single page (Features / FAQ) makes sense. |
A general "how to" section may also make sense as a breakout? So we have: Features: a list and short description of each How-To: more in-depth about how to do certain things FAQs: Questions people ask that don't necessarily go over features but could be things like "hey I'm having this weird issue with my setup that I installed onto Windows 10" and there's information that only the Docker method is supported, etc. |
Yeah it's a first step of making that page more palatable. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah I'm not big on how repetitive it looks but either way it's substantially better than how it is now so I don't really care
I kept [the toc] there to be able to get a link to a specific question
Absolutely, I use that all the time. Plus clicking on it auto expands the collapsed section
Approved, will let you merge in case you want to change anything
At least from an organization standpoint it makes sense to me to break things out to something like this: Pre-Install (Section / Header)
Post-Install
|
Divided the docs up into to following general topics. I used h2 for the titles and moved the question title to h3. This will add bit of clutter to the toc. We could also just use large text if it is prefered.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like this much better!
I see its now live - Awesome. I'll be reviewing to add in some things (like the most recently asked question of linking ingredients to steps). Nice work @Kuchenpirat ! |
What this PR does / why we need it:
This changes the layout of the faq section in the docs.
We are adding more and more faqs which is good but the usability of the page is decreasing because of its length. This moves everything into expandable spoilers that contain just the question when not expanded.
Which issue(s) this PR fixes:
None, i am happy to discuss if it makes sense to do this.
Special notes for your reviewer:
Testing
Manual.