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

Human documentation #4

Closed
frankdejonge opened this issue Apr 14, 2016 · 2 comments
Closed

Human documentation #4

frankdejonge opened this issue Apr 14, 2016 · 2 comments

Comments

@frankdejonge
Copy link

There's only generated API docs, which basically says as much as my IDE does. It would be nice to have some documentation which illustrates the different use-cases of the SDK as well as the conventions around it. The project I'm currently working on uses contentful but we're hesitant to use the provided SDK because the lack hereof.

@frankdejonge
Copy link
Author

Just saw there's docs here: https://www.contentful.com/developers/docs/php/tutorials/getting-started-with-contentful-and-php/ might be good to link to this from the repo. Common package search flows are: Packagist -> Github Repo / Readme -> Docs.

@realityking
Copy link
Contributor

Hey Frank,

sorry for not responding to this earlier, I somehow missed the notification. Good catch on the docs, when we first published the SDK we didn't have any of the tutorials and later I never thought about this. I just pushed a commit that contains links to the rest of the docs.

If there's anything missing in terms of documentation (or other things) please keep opening issues 😄

Cheers,
Rouven

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

No branches or pull requests

2 participants