reorganize Assistant docs into multiple sections #228
Conversation
sections - overview - getting started - chat - completions - customization - tips & troubleshooting
✅ Deploy Preview for positron-posit-co ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| ## Glossary | ||
|
|
||
| ### BYOK |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Posit.Headings] 'BYOK' should use sentence-style capitalization.
There was a problem hiding this comment.
If we want to keep the Glossary section, I'll fix this up
juliasilge
left a comment
juliasilge
left a comment
There was a problem hiding this comment.
Thank you for working on this! 🙌
Can you make sure we are using "dataframe" vs. "data frame" consistently in these files?
|
|
||
| :::{.callout-important} | ||
| Positron Assistant requires a **Claude Console account** with API access. See Anthropic's [Claude API and Console](https://support.claude.com/en/collections/5370014-claude-api-and-console) documentation for more information. | ||
| Positron Assistant is provided relevant information about your current workspace through metadata about your Positron environment and through tool calling: |
There was a problem hiding this comment.
This "and" is very confusing to me. Maybe we can just take off "tool calling" here?
|
|
||
| #### Additional resources | ||
|
|
||
| Custom chat modes are now called custom agents in VS Code documentation. To learn more about the format of custom agents, see the following VS Code documentation: |
There was a problem hiding this comment.
This is already updated in the dailies to "custom agents" and will be in a regular release within a day or two. Do you think you could update this now, to be more up-to-date?
There was a problem hiding this comment.
Let's update this once posit-dev/positron#10889 is implemented, as part of posit-dev/positron#10614
|
Non blocking for future: It can look similar to this welcome page https://deploy-preview-228--positron-posit-co.netlify.app/welcome.html |
|
|
||
| ::: {.callout-important} | ||
| Positron Assistant is a **preview** feature in Positron 2025.07.0-204 and beyond. | ||
| Positron Assistant is an AI client that provides LLM integration within Positron, both for chat and for inline completions. Currently available in **preview** (Positron 2025.07.0-204 and beyond), it supports **Anthropic Claude for chat** and **GitHub Copilot for code completions and chat**. |
There was a problem hiding this comment.
Can we 1-2 sentences about the value prop here. I.e. "Positron Assistant is an AI client built specifically for data science workflows."
Maybe even include some example questions you can ask Assistant like "Why is my plot showing unexpected outliers?"
Co-authored-by: Julia Silge <julia.silge@gmail.com>
Co-authored-by: Julia Silge <julia.silge@gmail.com>
Reorganized structure
Looking for feedback on
Future work
Preview link
https://deploy-preview-228--positron-posit-co.netlify.app/assistant.html