Re: Documentation structure - would love to hear your thoughts
| From: | Christoph M. Becker | Date: | Sat, 10 Dec 2016 00:22:07 +0000 |
| Subject: | Re: Documentation structure - would love to hear your thoughts | ||
| References: | 1 | Groups: | php.doc |
| Request: | Send a blank email to phpdoc+get-969386445@lists.php.net to get a copy of this message | ||
On 09.12.2016 at 09:12, schrieb Maciej Sobaczewski wrote:
> Hi folks,
>
> I've started a non-binding discussion on /r/php regarding possible ways
> to improve the PHP manual.
>
>
> https://www.reddit.com/r/PHP/comments/5h7c5w/how_can_be_the_php_manual_improved/
>
>
> I have created bug report to track on of the complaints mentioned there
> https://bugs.php.net/bug.php?id=73698 (and which I also heard
> alot before).
>
> What are your thoughts on that topic?
Thanks for bringing this up, Maciej!
I fully agree that the structure of the manual isnt't optimal and should
be improved. I'm not sure how (I'd have to think about that and also
completely read the reddit discussion).
However, for me an even bigger issue is the search functionality (there
are several bug reports pending). Especially annoying is that I can see
autocompletions for some items (e.g. "$_COOKIE"), but choosing the entry
gives a 404 – well, actually it is a 200 with some information that
$_cookie doesn't exist. That's terrible!
Furthermore, the search is actually looking for identifiers, but is not
useful for searching the more general chapters (language/, faq/, etc.)
Frighteningly, searching for PHP related info via Google not rarely
gives better results than searching on php.net.
Cheers,
Christoph
> Cheers,
> Maciej.
>
> PS: allowed myself to CC Peter as he's Manual Editor and Christoph as
> most active contributor last times.