First steps toward bank user guide #4460
Merged
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
|
Saw this and had a suggestion - have you heard of video automation? Narakeet has a nice free tier and $6/30 minutes afterwards which lets you generate video with audio narration from a 10kb max markdown script. It's kind of like if you wrote a powerpoint in markdown, Narakeet will generate the audio narration and slideshow presentation in video format automatically. |
|
@jimmyli97 Thanks for the suggestion! My reasoning behind doing a mainly textual user guide is that it will be plausible to have anyone make updates to it. So keeping it simple! |
… getting started partners information
…nd draft of "Asking for Changes"
awwaiid
approved these changes
Jul 21, 2024
|
Thanks! Onward and upward! |
|
@cielf: Your PR |
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.
Description
We need a maintainable user guide. Every so often we make a change that outdates our current documentation. (That just happened with Dashboard)
There is a balance to be struck between maintainablity, usefulness, and user-friendliness.
At this point, what we have is a table of contents and a handful of sections written. The intent is that several people will contribute to this, and that @cielf will serve as editor-in-chief on it, but that we'll have the rest of the senior team do a review before publicizing it / putting links to it in communications.
The tradeoffs on doing this as a markdown document are: maintainablility vs having a pretty format vs providing something for people who learn better from video than text. I don't think we have the manpower to maintain a full video tutorial over time, but it may be useful to provide a few demo type vids, especially around the partner experience, as the banks don't necessarially see that.
Using markdown makes it plausible to keep things up to date with changes to the UI.
Type of change