implement welcome and help screens for better onboarding #51
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
casperstorm
force-pushed
the
feat/welcome-and-help
branch
2 times, most recently
from
504175d
to
ac72fec
Compare
casperstorm
force-pushed
the
feat/welcome-and-help
branch
from
fc3406d
to
85f7dc7
Compare
casperstorm
force-pushed
the
feat/welcome-and-help
branch
from
85f7dc7
to
fc5ecdf
Compare
casperstorm
changed the title
tarkah
approved these changes
Jun 26, 2023
There was a problem hiding this comment.
Looks great, @casperstorm!! Found just a couple things.
I think it might be wise for us to "pre-populate" a default config.yml file into the config dir if none exists. So when use is on welcome screen and they open config dir, there is already a file there for them to edit. We can include_bytes the repo file and write it there when they click open directory maybe?
Or should we instead include a GH link to the file for them to open / reference? This way we don't auto-create any file which would cause the welcome screen to not load next time if they took no action.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added a help and welcome screen to Halloy.
This also simplifies our logic initially so we don't pass down a config error all the way to empty buffer.
The welcome screen will be displayed if there's no configuration file found, and then guide the user through a few steps to set it up. The help screen will displayed as soon as something is wrong with the configuration file, and tell what went wrong.
If all is okay, we show dashboard.
closes #53