phpDocumentor icon indicating copy to clipboard operation
phpDocumentor copied to clipboard

/configuration page is almost useless

Open dktapps opened this issue 4 years ago • 6 comments

https://docs.phpdoc.org/3.0/guide/getting-started/configuration.html

This page gives almost no meaningful information whatsoever, and tells me to look at the xsd (which isn't the most user-friendly way of displaying config information). I spent 10 minutes thinking "surely they can't possibly expect new users to use THIS as a config reference??"

Much to my surprise, I later discovered that there's a second Configuration page further down the sidebar, which is far more useful: https://docs.phpdoc.org/3.0/guide/references/configuration.html

Please do something about this. It's confusing and sure to be a hair-puller.

dktapps avatar Nov 09 '21 20:11 dktapps

~The xsd in the repo also doesn't seem to be up to date, so I have PhpStorm screaming at me when I try to add source paths.~ Never mind! seems like I just can't read XSD.

Also, https://docs.phpdoc.org/latest/phpdoc.xsd gives a nice 404.

dktapps avatar Nov 09 '21 20:11 dktapps

I went through the same stages you did.

Also, https://docs.phpdoc.org/latest/phpdoc.xsd gives a nice 404.

At least it now points to https://github.com/phpDocumentor/phpDocumentor/blob/master/data/xsd/phpdoc.xsd.

thomascorthals avatar Dec 28 '21 12:12 thomascorthals

At least it now points to https://github.com/phpDocumentor/phpDocumentor/blob/master/data/xsd/phpdoc.xsd.

I still get a 404.

dktapps avatar Dec 28 '21 12:12 dktapps

I still get a 404.

I meant to say that https://docs.phpdoc.org/3.0/guide/getting-started/configuration.html now links to https://github.com/phpDocumentor/phpDocumentor/blob/master/data/xsd/phpdoc.xsd and that link should work.

thomascorthals avatar Dec 28 '21 12:12 thomascorthals

Still an issue, both with the quality of the the first configuration page, and the 404.

See https://github.com/phpDocumentor/phpDocumentor/issues/3221

emmadesilva avatar Apr 30 '22 17:04 emmadesilva

I am working on a major update of the documentation but progress is slow on such things.

mvriel avatar Jul 22 '22 21:07 mvriel

XSD links is fixed and since the effort to update the documentation is on-going, I am going to close this issue. Thank you for your feedback!

mvriel avatar Dec 07 '22 07:12 mvriel