opened
FLamparski
username_0
We all know that reading the source code is the best way to learn about a particular system, and the code is quite readable. However I think many developers would appreciate a separate documentation, or at least more examples like how to make a more complex query etc.

I can help with that but I'll defer to you whether we use Sphinx + ReadTheDocs or PHPDoc + GitHub Pages, or something else entirely.
Better documentation needed
issue
created
calcinai
username_1
I've used Sphinx, but like the idea of the doc being in the code, since it probably won't be too verbose anyway.  I think that way it's more likely it stays up-to-date.
comment
created
FLamparski
username_0
I'm tinkering with adding some docs to the code on my fork, will PR you soon. I see you're already generating PHPDoc comments for the models, that's cool!
comment
created
ultradox
username_2
More examples and documentation would be much appreciated. The readability of the source code is a function of one's level of expertise, and I'm struggling. I don't understand how to harness return data, as described here https://community.xero.com/developer/discussion/51339152/

Any pointers or assistance would be much appreciated.
comment
created
calcinai
username_1
@username_2 it's definitely something that needs doing, especially now that Xero are recommending this library.  Unfortunately I just don't have the time to write it up at the moment - part of me also didn't want to do it until the 2.0 branch is out (a looooong time coming).
comment
created
calcinai
username_1
@username_2 In answer to your question on the Xero forum, look at the usage [here](https://github.com/username_1/xero-php#usage) for the basic idea - you'll get contact objects in there that will have all the methods available.
comment
created
ultradox
username_2
Thanks for the advice on the Xero forum, I'll try it out.
comment