oasisprotocol / oasisprotocol/rofl-app

Templates: Can we make the instructions more prominently displayed during the app creation flow?

Open
#209 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
1
Forks
1
Avg merge
46m
Merged PRs (30d)
1

Description

Currently, the template's instructions are hidden underneath the "Need help?" button in the top right corner:

Image

Try to redesign the template creation flow that would include instructions more prominently because the intended users will (mostly) always need those.

Ideas:

  • Start the template creation flow with some introductory text / video walk-through?

  • Can we make some instruction be more inline (i.e. "closer") to the actual input fields rather than part of an isolated README?

  • Should instructions be visible by default (i.e. no need to click "Need help?" button)? How to handle overlapping with the main content better in this case?
    Current issue on narrower screens:
    Image

  • How to guide the user through the parts that need to be preformed before creating an app or after the app is deployed?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the template creation flow and the existing “Need help?” instructions panel. Review how the flow behaves on narrow screens, then define a design that makes guidance prominent, places relevant instructions near inputs, and covers steps before creation and after deployment. Done means the revised flow addresses the listed guidance and overlap concerns.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
design, frontend, web-dev
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.