panel icon indicating copy to clipboard operation
panel copied to clipboard

Mention JSComponent in Explanation/Components docs?

Open cdeil opened this issue 1 year ago • 7 comments

@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 avatar Aug 10 '24 19:08 cdeil

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

cdeil avatar Aug 10 '24 21:08 cdeil

The latter

MarcSkovMadsen avatar Aug 11 '24 13:08 MarcSkovMadsen

@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

cdeil avatar Aug 11 '24 17:08 cdeil

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.

philippjfr avatar Aug 11 '24 18:08 philippjfr

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

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

  • Pro: everyone gets good dev experience always, no need for reminders.
  • Con: an extra dependency. But it's a small (ca 1 MB) and simple one compared to pandas & bokeh and other core dependencies panel has already.

cdeil avatar Aug 11 '24 18:08 cdeil

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?

MarcSkovMadsen avatar Aug 11 '24 18:08 MarcSkovMadsen

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".

cdeil avatar Aug 11 '24 18:08 cdeil