Skip to content
This repository has been archived by the owner on Nov 25, 2020. It is now read-only.

Documentation - simple usage #170

Open
SecondeJK opened this issue Sep 5, 2017 · 1 comment
Open

Documentation - simple usage #170

SecondeJK opened this issue Sep 5, 2017 · 1 comment

Comments

@SecondeJK
Copy link

I've spent a bit of time learning how this bundle works slowly. It works well, but I think the readme could really benefit from the most basic usage example - for instance:

I have 3 items in an array.

I want to paginate them.

Here's how you do it in the controller using an adapter (this is covered pretty well)

Here's how you render, in Twig

  1. The current list of items to loop through
  2. The paginator
  3. The controller routing so that you print the current page.

While some rendering bits are covered, the routing and rendering of items aren't really, making it a slow process to understand how to do this, which is after all the first thing anyone is going to want to do on a paginator.

If I have time and/or you agree I can write a draft of this and PR it

@sampart
Copy link
Owner

sampart commented Sep 5, 2017

That sounds very sensible, @SecondeJK. Thank you for offering to help - you're right that the documentation could be made clearer. A PR would be great if you get time; thank you very much 👍

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

No branches or pull requests

2 participants