VeryGoodOpenSource / VeryGoodOpenSource/formz
docs: provide interactive demonstration on README
Nobody has claimed this yet.
- Dominant language
- Dart
- Stars
- 487
- Forks
- 42
- Avg merge
- 4d 9h
- Merged PRs (30d)
- 2
Description
Is your feature request related to a problem? Please describe.
Inspired by #95, users should be able to run the example to quickly evaluate the package.
Describe the solution you'd like
I would like users to be able to try out an application using formz with a single click. Ideally, without cloning and having to run the example themselves.
The solution I'l like is to have an image within the README that when clicked opens a hosted page with the running example.
Describe alternatives you've considered
Another option is to wait until pub.dev support hosting the examples for users to interact with.
Additional context
- See Modal bottom sheet, that had an interactive demonstration.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the README and the existing example application, then review the linked Modal bottom sheet demonstration for a comparable interactive README experience. Done means the example is available on a hosted page and a README image opens it with a single click, without requiring users to clone the repository.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- dart
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100