docs: add mypy plugin configuration note for param (#8614)

[rimsha152007-dotcom]

Fixes #8614

[hoxbro]

This is not the right place for this information as this is intended on developers working on panel itself.

[rimsha152007-dotcom]

This is not the right place for this information as this is intended on developers working on panel itself.

Thanks for clarifying @hoxbro! That makes total sense—developer_guide is for Panel contributors.

Should I move this note to doc/how_to/param/uis.md (or another specific file under how_to), or is there a better location you'd recommend for mypy configuration docs?

[hoxbro]

I think the best place is to create a new file in how_to. Also link to the param guide https://param.holoviz.org/en/docs/latest/user_guide/Typing.html.

[philippjfr]

Agreed, I think we may actually want a whole new section right at the beginning of the how-to "Develop Efficiently" section with "Typing" as the first topic or just put it in the "Develop in an editor section".

[rimsha152007-dotcom]

Thanks @hoxbro and @philippjfr for the guidance!
I've made the following changes:
Created a new doc/how_to/typing/index.md page covering how to configure the mypy plugin for Param/Panel, with a real example based on the original issue (pn.chat.ChatMessage.show_reaction_icons)
Linked out to the Param Typing guide for further details, as suggested
Added a new card for "Type check your code" under the "Develop Efficiently" section in how_to/index.md
Registered the new page in prepare_to_develop.md's toctree so it shows up in the sidebar

Let me know if this looks like the right structure/location, or if you'd prefer the section placed differently!

[hoxbro]

4c7c877 should be reverted.

[hoxbro]

The failing tests are unrelated.

Can you remove the changes in doc/developer_guide/index.md?

[rimsha152007-dotcom]

The failing tests are unrelated.

Can you remove the changes in doc/developer_guide/index.md?

@hoxbro! I've removed the "Type Checking" section from doc/developer_guide/index.md

Let me know if there's anything else you'd like changed!

[hoxbro]

Just a quick confirmation that you have run the example code locally and get this error.

[rimsha152007-dotcom]

Just a quick confirmation that you have run the example code locally and get this error.

I haven't run it locally myself, since my part here was writing the documentation rather than implementing the fix..The example and error message are taken directly from the original issue (#8614), Happy to run it locally too if that would help before merging.