stayallive / wp-sentry

A (unofficial) WordPress plugin reporting PHP and JavaScript errors to Sentry.
https://wordpress.org/plugins/wp-sentry-integration/
MIT License
305 stars 48 forks source link

docs(readme): fix broken documentation links #87

Closed rtpHarry closed 3 years ago

rtpHarry commented 3 years ago

Sentry have committed the classic sin of updating their documentation url structure and not setting up redirects. Equivalent new urls added into docs.

rtpHarry commented 3 years ago

For the php options, I've updated it to use the public documentation url, as that was what was already in the docs.

However the plugin actually uses a \Sentry\Options object which is documented here and it uses a collection of methods to access the settings rather than the array thats in the public docs.

Perhaps both links should be included in the PR?

rtpHarry commented 3 years ago

Actually, looking into this further, the docs in general are wrong.

There is no array that is returned, its a Options class, so this section actually needs an overhaul:

https://github.com/stayallive/wp-sentry#wp_sentry_options-array

That's beyond just fixing the broken urls, I'm going to open it as a separate issue as its gone midnight here and I'm done for the day.

stayallive commented 3 years ago

Thanks!