holoviz / panel

Panel: The powerful data exploration & web app framework for Python
https://panel.holoviz.org
BSD 3-Clause "New" or "Revised" License
4.76k stars 518 forks source link

Mention JSComponent in Explanation/Components docs? #7122

Open cdeil opened 2 months ago

cdeil commented 2 months ago

@MarcSkovMadsen and @philippjfr - would it make sense to mention JSComponent or whatever the new ESM component classes are in the docs also under Explanation -> Components?

I wanted to learn about them and my first instinct was to look here:

https://holoviz-dev.github.io/panel/explanation/index.html#components

Screenshot 2024-08-10 at 21 47 18
cdeil commented 2 months ago

There's also an inconsistency where docs pages link to reference/custom but currently the files are generated under reference/custom_components.

Which one should it be?

https://holoviz-dev.github.io/panel/tutorials/expert/custom_components.html

Screenshot 2024-08-10 at 23 25 16
MarcSkovMadsen commented 2 months ago

The latter

cdeil commented 2 months ago

@MarcSkovMadsen - can you fix this as part of #7127 ? (I could send a PR, but don't want to overlap)

One more thought: suggest to remove the "Prerequisites" from https://holoviz-dev.github.io/panel/tutorials/expert/custom_components.html#prerequisites

I think like most other tutorials we can simply assume that Panel install is in place.

Screenshot 2024-08-11 at 19 11 26
philippjfr commented 2 months ago

I think like most other tutorials we can simply assume that Panel install is in place.

Indeed, I'd be happy with a little admonition reminding people that watchfiles will give them a much better development experience.

cdeil commented 2 months ago

reminding people that watchfiles will give them a much better development experience

@philippjfr - Or just make watchfiles a required dependency? ;-)

MarcSkovMadsen commented 2 months ago

The basic Project tutorials are made as self contained as possible.

We share links to them on social media. They can be the first docs a new user meets. So I believe they should be there. But who knows What the correct approach is?

cdeil commented 2 months ago

The basic Project tutorials are made as self contained as possible.

It's currently under "Expert tutorials". I guess for people that know JS it could be considered and go under "Basic" or "Intermediate".