Proposal for simplified user onboarding#454
Draft
emmby wants to merge 397 commits into
Draft
Conversation
Contributor
|
Had a good video call with @emmby a few weeks ago to discuss. We are exploring ways to help simplify StateSmith even more for new users while still retaining power features for advanced users. @emmby has also been great at consolidating and updating StateSmith documentation which is currently spread between main repo, tutorial repos and wikis. |
This file contains hidden or 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
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.
This is a draft PR to demonstrate how we can make StateSmith very easy to use by new users. At a high level, it consists of a set of docs, a simplified commmand line tool, and build integrations with popular package managers.
You can preview the new documentation here: https://emmby.github.io/StateSmith/
The docs also look good in light and dark modes, and they work on desktop and mobile.
The PR still needs more work, in particular there's a lot of content still missing. But I wanted to align on the direction and get your feedback to see if there's value in finishing it up in time for your presentation.
TODO