FarmBot / FarmBot/Farmbot-Web-App

Help Modals

Open
#1,766 0 comments 0 reactions 0 assignees View on GitHub
feature
Dominant language
TypeScript
Stars
973
Forks
356
Avg merge
1h 6m
Merged PRs (30d)
3

Description

Many features have expanded descriptions in the software docs which requires users to hop between the app and the docs to read all available information. I think it would provide a more streamlined experience if these expanded descriptions were in the app itself. That would allow the content to be more easily discovered and consumed, and it would be more readily translatable too.

The current tooltip elements seem best suited for short tidbits of text-only information (1-3 sentences max), so to provide a medium to long amount of rich content, I think a **help modal** will work better. Ideally the feature would support translations, videos, images, callouts, and other rich markdown-y text formatting. Oh, and scrolling for longer content on phones.

Example:
![Help Modals](https://user-images.githubusercontent.com/5524043/80046267-fe1a2380-84be-11ea-8119-cb20c4ae05f8.jpg)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.