Improve Readme and doc
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 25/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- dart
- Domain
- documentation
Research direction
Start with the repository README and compare its parameter names with method signatures and documentation, then review issue #47 and the linked RxCommand and RxDart blog series. Clarify the documentation scope and choose a consistent set of names; done means the newcomer guidance reflects the current API and the proposed wiki material is up to date.
Written by the indexing model from the issue text.
Description
I really appreciate this package but I find the documentation difficult for newcomers:
- Various discrepancies in the name of the parameters between Readme, methods' signatures and Doc. For example these 3 names are used for the same parameter:
canExecute,restriction,registration. I saw that this problem is mentioned in issue #47 Nullability support which cite another different name,constraint. - The Readme seems to be aimed at those who already have some familiarity with this architecture, which is understandable; in the blog https://www.burkharts.net/apps/blog there are articles suitable for newcomers, but they are not up-to-date (for example, reference is made to the Observable of RxDart, which from version 0.23 directly uses the Stream). Not that this is a problem, I just guess that's why these guides weren't promoted more in the Readme.
I am inexperienced and unfamiliar with git but am available to help update the documentation. Personally, the guide that got me aficionado of this package was the blog article https://www.burkharts.net/apps/blog/rxvms-foundations-rxcommand-and-getit/, together with the two articles of the same series preceding it (which is much more complete than "Making Flutter more Reactive" mentioned in the Readme). One idea could be to update this series of articles to the current RxCommand and RxDart Api and make it available in the wiki of this repo.
- Dominant language
- Dart
- Stars
- 136
- Forks
- 22
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
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.
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
flutter-webrtc/flutter-webrtc#2206 ·
-
from.page-issue
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
triage
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
[Super Editor][Chat] - Floating editor scaffold does not reset panel height after closing panel Open
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
status: needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
a2ui-project/a2ui#2763 ·