Skip to content

Add FAQ's to the documentation #392

Description

@peterramsing

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

Activity

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

Metadata

Metadata

Assignees

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions