Improve docs

[tyler36]

No description provided.

[tyler36]

@rfay If you have time, could you give this the once over?

[rfay]

Sure, it will probably be a day or two.

[rfay]

I made several suggestions, but overall I didn't see real profiling data when I got it going. I only saw basic stuff, not the breakdowns I would expect showing where memory and CPU were used most, and the individual wall times.

It's worth including an xhgui launcher custom command as well so people don't have to go do ddev describe to find the port. And mention in the README that the port will be displayed in ddev describe.

Here's what I see:

[rfay]

This is the kind of detail I was expecting to see (what ddev xhprof provides by default)

[tyler36]

This is the kind of detail I was expecting to see (what ddev xhprof provides by default)

The kind of detail is available but you need to click through on a specific request.

[rfay]

Thanks for showing me where to click, I clicked on the run, but not on the method. It's probably a good thing to add to the README? Or perhaps that's just the job of the upstream docs.

[tyler36]

Thanks for showing me where to click

The first time I got data into xhgui, I too was "underwhelmed"; it was pretty but where was all the good data?

[tyler36]

• added link to an online demonstration (9fd5551)
• added description with image for "GET" 390da3f

[tyler36]

Snuck in the helper command, ddev xhgui to launch (f321f43)

[rfay]

Test with ddev get https://github.com/tyler36/ddev-xhgui/tarball/20231106_drupal_settings

[rfay]

This is looking great, thanks! Now that I know where to click.

• I note that the volume for the mongo stuff (ddev-d10_xhgui-mongo) doesn't get deleted when the add-on is removed (but it would on ddev delete I think). That might be a thing to do in a follow-up.
• I am not sure why this uses its own mongo instead of depending on ddev-mongo, but ok...
• For the xhprof_prepend.php, we just have to get our heads together and think about how to handle it.

Awesome work, huge step forward.

[tyler36]

I think there are enough good changes here to merge.
This will make it much easier for people to start using this addon.

All of the documentation feedback was address, and there are issues opened for other implementaion points ( #11, #13 , #14 ).

Thank you for your help and review.