doc: Add extended migration guide

[AlejandroFernandezLuces]

No description provided.

[RobPasMue]

Docs look good but I would ask @PipKat to have a look at them

[PipKat]

Most of the suggested edits are style-related or for adding links to better direct the user to information.

[PipKat]

Alex K. once told me that we should include () after function and method names. I'm just putting that out there if you want to make such changes globally.

[AlejandroFernandezLuces]

Alex K. once told me that we should include () after function and method names. I'm just putting that out there if you want to make such changes globally.

I can do it for the references in the examples, but in the documentation, when referencing and linking to the API reference, the parentheses do not appear:

I would prefer to not have the parentheses for consistency, they cannot be added to these references. What do you think?

[PipKat]

Alex K. once told me that we should include () after function and method names. I'm just putting that out there if you want to make such changes globally.

I can do it for the references in the examples, but in the documentation, when referencing and linking to the API reference, the parentheses do not appear:

I would prefer to not have the parentheses for consistency; they cannot be added to these references. What do you think?

It agree it makes sense not to as consistency here would be preferred. What is the trick to having just the last part of the long API shown as the display link--with the full API path shown as the tooltip? I just recommended another developer try to implement this technique in his PR but forgot how it was done!

[AlejandroFernandezLuces]

What is the trick to having just the last part of the long API shown as the display link--with the full API path shown as the tooltip?

The tilde at the beginning is what tells Sphinx to only show the last bit:

:class:`~ansys.tools.visualization_interface.backends.pyvista.PyVistaBackendInterface`