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

Add FAQ's to the documentation #392

Open
peterramsing opened this issue Jul 26, 2017 · 3 comments
Open

Add FAQ's to the documentation #392

peterramsing opened this issue Jul 26, 2017 · 3 comments

Comments

@peterramsing
Copy link
Owner

peterramsing commented Jul 26, 2017

FAQ Docs Feature

Abstract

  • To replace the "gotchas" with a more Question and Answer style UI/UX that allows for being searchable from Google and quickly scannable for "what my issue is"

User Stories

As a I want to So that
user easily see if the error I'm getting is in the FAQs so I know if I can fix it myself or do I need to reach out
user traverse the FAQs quickly without seeing all the answers until I find the question that matches what I'm looking for so that I don't accidentally miss what I'm looking for
new contributor easily add FAQ questions and answers to the docs so that I actually do it instead of giving up or just adding an issue for "someone else to"
user new ❗️ see an issue(s) that relates to this questions I can have an even deeper dive into what might be causing my issue

Design:

@japick to design

@peterramsing
Copy link
Owner Author

peterramsing commented Jul 26, 2017

Starter Questions:

Q: I'm getting an error: [TypeError: Cannot read property 'split' of undefined] when processing my styles. What's could be the issue here?
A: Ensure that your pre-processed CSS (e.g. LESS, SCSS, Stylus) has processed correctly.
Issues: #268


Q: I am getting undefnedn in my CSS. Why?
A: That's an issue with LESS where you need to escape fractions because LESS will divide those numbers before allowing LostGrid to use the faction as it should. Just escape the fraction like so: lost-column: ~"1/3";
Issues: #178, #229, less/less.js#974

@peterramsing
Copy link
Owner Author

@japick I added a new user story for linking to issues. Let me know what you think

@japick
Copy link
Collaborator

japick commented Jul 28, 2017

I guess the 4th user story would be covered by linking to issues in the answers (as you've done with the starter questions). Definitely helps to give the answers some context.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants