Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation needs more examples. #74

Open
mdaslamansari2008 opened this issue Mar 25, 2019 · 9 comments
Open

Documentation needs more examples. #74

mdaslamansari2008 opened this issue Mar 25, 2019 · 9 comments

Comments

@mdaslamansari2008
Copy link

The documentation is not covering all scenarios. It would be great if you can add more details with example codes

@XOneto9
Copy link

XOneto9 commented Apr 9, 2019

I agree with @mdaslamansari2008.
just to get the sample on the 'read me', very difficult to understand when and what I use the components.

@roberthein
Copy link
Owner

I also agree and started a re-write! 🤘

@mdaslamansari2008
Copy link
Author

mdaslamansari2008 commented Apr 9, 2019

Thank you. I found this solution better than other. And I see huge potential in this. So please write in details. Try to cover most of the scenarios and also what are the common errors expected and what sort solution can fix it. That will be great to make most out of it. Thanks once again.😇

@roberthein
Copy link
Owner

That's great input @mdaslamansari2008, Thank you. 🙏

@mattmassicotte
Copy link
Contributor

Hello @XOneto9 - I'm embarrassed to say I'm not sure what I did that you agree with :) Could you point me at whatever it is you are referencing so I can refresh my memory?

@XOneto9
Copy link

XOneto9 commented Apr 10, 2019

@mattmassicotte
OMG.. I’m so sorry it is mistake to refers you,
I think it is mistype on the writing my opinion :(
Raaaaally soorrrrrry about that;;

@mattmassicotte
Copy link
Contributor

@XOneto9 Oh, really don't worry about it! Mystery solved :)

@tonemcd
Copy link

tonemcd commented May 15, 2019

Just some thoughts on what could be useful as documentation. I've come from SnapKit (too cumbersome) via Stevia (too many APIs - not easy to know which one to use) to TinyConstraints, and I managed to convert my simple App (3 ViewControllers, about 6 or so views in each) to using TinyConstraints in just over an hour, so I'm very impressed! The Example App is excellent and shows what can be done. I must admit though, it's a bit over my head at the moment.

The docs at the moment give a good overview of what is possible. I think what would be very helpful is recipes, here's two for example;

  • How to align two (or more) views by their bottom edge or baseline (or any other edge). Is it possible to have an array of views all aligned by the same edge? If it can only be done by viewA.top == viewB.top, viewB.top == viewC.top, that's fine. It's just not obvious at the moment (the ==, or equation based API comes from Stevia, which is very good, but it has three API's: visual layout, chainable and equation-based and it's not clear when to use each one).
  • How to evenly space out some views (eg 4 buttons on the vertical/horizontal axis).

Thanks for a great framework, whilst writing this out, I realised that something I was wracking my brain with (collection of a image-label-button view into its own subclass of UIView to allow it to be used repeatedly) could be done using the 'stack' method, and so I implemented that - works very well! (I couldn't find it being used in the Example App though).

Hope this feedback is constructive to you.

@rebeloper
Copy link

If you're looking for an in depth video documentation here it is: https://www.youtube.com/watch?v=ucbaEkEJKrc&list=PL_csAAO9PQ8ZHY2VzOi7LJ80CtfAgCgHP

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

6 participants