Document markdown docs and llms.txt addition - #1751
Conversation
maximlt
left a comment
maximlt
left a comment
There was a problem hiding this comment.
I think I understand why you stuffed this in the developer guide: we haven't yet merged one of the PRs that add How To guides. This PR definitively adds how-to kind of content though! The developer guide is for people contributing to hvPlot's code base itself, this content is for hvPlot users who need to configure/help their coding agents with writing hvPlot code. Can you add the top-level How-To section (like you've already done in other PRs) and a how-to with this content? You might have to adapt the content a bit.
|
I've created the UnrelatedAs an aside, maybe the How-to PRs need some love soon 👀? |
|
|
||
| 3. Ask your assistant to read the pages relevant to your task before writing code. For example, to create a plot you might have it read `tutorials/getting_started.md` and the API reference page for the method you need. | ||
|
|
||
| The Markdown pages are intentionally free of the navigation chrome, CSS, and JavaScript of the full HTML site, so they consume far fewer tokens and are easier for an assistant to parse. |
There was a problem hiding this comment.
Might be worth noting that the markdown is stripped from all the plots, so the AI cannot "see" the plots even if it tried to.
There was a problem hiding this comment.
Yes, this is intentional as the objective is to have it write correct, updated code. The user gets to see the output themselves and decide if that's what they want. I'm not sure if we really need to mention that here.
@ahuang11 thoughts?
| holoviz-skills install --copilot | ||
| ``` | ||
|
|
||
| 3. Restart your assistant so it picks up the newly installed skills. |
There was a problem hiding this comment.
Do I need to explicitly "call" the skills in my coding agent (/holoviz-skills bla bla)? If not, are there specific keywords I should include in my prompt? Like should I prompt "make this plot with hvplot", or is "make this plot" enough?
There was a problem hiding this comment.
If you have the skills installed, you don't have to explicitly call it but you may have to also say "...with hvplot" for it to automatically use the skills. But I think @ahuang11 can say more about that.
maximlt
left a comment
maximlt
left a comment
There was a problem hiding this comment.
Please review my suggestions 🙏
2 participants
Description
This PR documents the addition of the markdown and llms.txt build process to the docs following 442bb85.
The same will be done in HoloViews and Panel afterwards.