lost
lost copied to clipboard
peterramsing
Add FAQ's to the documentation
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
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: https://github.com/peterramsing/lost/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: https://github.com/peterramsing/lost/issues/178, https://github.com/peterramsing/lost/issues/229, https://github.com/less/less.js/issues/974
@japick I added a new user story for linking to issues. Let me know what you think
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.
