further clarify the third party user documentation #137
Conversation
|
This is good and correct but I would like that this page is more "direct". More "No bullshit just tell me what to do". I think this page is different form all other documentation pages because this page should be linked from the Ie, "You got here because a package you like is using HTTPlug. You need to do 1, 2 and 3." And then in a A different approach would be to have e TLDR with says: "Read this page or, (if you lazy) run this command and you are good to go:" composer require php-http/curl-client guzzlehttp/psr7 php-http/message php-http/discoveryAnd then have the rest of the page a little more descriptive just as the PR is. |
|
personally, anything with less explanation would confuse me more than encourage me to use the process. but i like the TL&DR idea. it will show that its basically simple, and those people that care to understand what they are doing can read on a bit without having to hunt through the whole documentation to puzzle out what is going on. i will try to update this soonish |
dbu
force-pushed
the
improve-user-doc
branch
2 times, most recently
from
807bc97 to
d6db8d2
Compare
|
updated. i did not include discovery. now that discovery is lightweight,
libraries that want to use discovery should simply declare a dependency
on it.
|
| First you need to choose library to send HTTP messages and that also provide the virtual package | ||
| `php-http/client-implementation`_. In the example | ||
| below we are using cURL. | ||
| TL&DR |
There was a problem hiding this comment.
Write "TL;DR"
|
thanks for the feedback, improved it |
|
Awesome! |
follow up to #125