Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
✅ Deploy Preview for positron-posit-co ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for positron-posit-co ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| - Function and package documentation | ||
| - Package vignettes (when available) |
There was a problem hiding this comment.
this is what is in the RStudio user guide, do we want to be more specific?
There was a problem hiding this comment.
Pull Request Overview
This PR adds user documentation for the new Help Pane feature, integrates it into the site navigation, and provides Copilot with documentation review guidelines.
- Introduced a
help-pane.qmdpage outlining how to use Help Pane in Python and R. - Updated
_quarto.ymlto includehelp-pane.qmdin the website menu. - Added
.github/copilot-instructions.mdwith Copilot’s technical documentation review rules.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| help-pane.qmd | New Help Pane guide with usage examples, supported content, and navigation tools |
| _quarto.yml | Included help-pane.qmd in the website’s navigation order |
| .github/copilot-instructions.md | Added Copilot prompt rules for reviewing technical docs |
Comments suppressed due to low confidence (1)
help-pane.qmd:13
- Inconsistent capitalization: ‘Help pane’ should be ‘Help Pane’ to match the component name throughout the document.
These methods will automatically open the Help pane and display documentation.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
I added some Copilot instructions to help pre-review style and tone. We can iterate on the instructions, but it already had a good suggestion on this small doc addition! It does make this PR feel a bit noisy before another human even sees it, but maybe we try it out and see if it feels like too much? |
| - Function and package documentation | ||
| - Package vignettes (when available) |
Co-authored-by: Julia Silge <julia.silge@gmail.com>
Addressing posit-dev/positron#7542