Adam-it/pnp-powershell-extension

Idea: Show samples within commandlet doc

Closed this issue · 4 comments

pkbullock commented

Hi Adam,

In the cmdlet view, is it possible to filter and show related samples? I do tag samples within the tags element of the samples.json - CLI cmds as well.

image

Adam-it commented

hmm.. not sure If I understand the idea fully so let's discuss it a bit. 🙂
So from what I understand we could add some kind of button like "show related samples" in the docs view of the cmdlet.
image

When user would click on this button the sample view would open in the editor showing the samples that use this cmdlet?
Did I understand this correctly ? would this behavior be ok ?
This would also fit nicely with other functionality I plan to add which is a button in the docs view which would open that doc page in browser so the user with single click would land on the correct page of PnP PS docs (or CLI as those extension actually have 90% same code base 😉)

Adam-it commented

@pkbullock any additional comments on this one? Seems that this is quite clear for me I would just like to confirm 😉

pkbullock commented

Yeah either show related samples or I was originally thinking show the sample cards at the bottom of the page BUT, what if there are loads so a button to navigate to samples probably the best.

Adam-it commented

showing the sample cards at the bottom of the docs page will introduce additional complexity which might be confusing for the user. Also the docs tend to be quite long (especially the list of parameters/options for a command), so the user might not always 'scroll down' to the bottom to actually see there are some samples related there.
If the button is fine with you then I think this is the approach I will take 🙂💪.

ok all clear 👍.
I will plan it to be done in the next development time for this extension.
Thanks @pkbullock for this awesome idea 🤩🤩