Initial README draft #12
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
|
|
||
| ### Overview | ||
|
|
||
| `StackViewController` is a framework that simplifies the process of building forms and other static content using `UIStackView`. |
There was a problem hiding this comment.
Do you think it's worthwhile to describe the typical UITableView approach here as well? Wonder if folks will recognize the pattern faster if we present this as a solution to the complexity of a UITableViewController for a form.
|
This is great! I think the two messages (that are already in this doc towards the end) that could slide to the top as headlines are:
|
|
|
||
| The purpose of this project is two-fold: encouraging design patterns that are more suitable for building content like the form pictured above, and providing tools to make the process simpler. The following sections contain a summary of the existing solutions and how we can improve upon them. | ||
|
|
||
| #### Building Forms with `UITableView` (Is Bad) |
There was a problem hiding this comment.
wdyt of changing 'Is Bad' to 'Is Difficult'? Think that will align more with the idea above that we're trying to simplify our process.
There was a problem hiding this comment.
or Is Hard, something less loaded
There was a problem hiding this comment.
Difficult sounds good!
|
:lgtm: |
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 my initial draft of the README, containing the overview of the project and the detailed design rationale. Feel free to nitpick, I want to make sure this gets the idea across properly.