-
Notifications
You must be signed in to change notification settings - Fork 48
Revamp the extension README #886
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not entirely sure about Julia support in Positron, but I would say it is as good as in VSCode.
I think the get started guides are the main links to show in the readme.
Maybe drop the last screenshot and set the width (as HTML) for the first one.
I would add a section "troubleshooting" or "getting help" to direct users to Quarto CLI repository or "quarto" monorepo.
| ## Positron | ||
|
|
||
| The Quarto VS Code extension includes commands and keyboard shortcuts for rendering Quarto documents (both standalone and within websites or books). After rendering, `quarto preview` is used behind the scenes to provide a preview pane within VS Code alongside your document: | ||
| [Positron](https://positron.posit.co/) comes ready to work with Quarto out-of-the-box; it includes both the Quarto command line interface, this extension, and support for enhanced features for Python and R as embedded languages. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| [Positron](https://positron.posit.co/) comes ready to work with Quarto out-of-the-box; it includes both the Quarto command line interface, this extension, and support for enhanced features for Python and R as embedded languages. | |
| [Positron](https://positron.posit.co/) comes ready to work with Quarto out-of-the-box; it includes both the Quarto command line interface, this extension, and support for enhanced features for Python, R, and Julia as embedded languages. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm going to wait on this, since we don't currently have the enhanced integration for the runtime.
Co-authored-by: Mickaël Canouil <[email protected]>
Co-authored-by: Mickaël Canouil <[email protected]>
|
@AshleyHenry15 I can't officially add you as a reviewer, but your eyes on this revamp would be super welcome! |
This PR makes some significant changes to the README, which had not been substantively edited since 2023. We don't touch this a lot, so I'd like this to be something that we feel good about being more minimal so we don't have it in the loop of our doc updates really regularly.
This is the file that shows up on these pages:
And in product here:
I will admit that I am doing a bit of Positron prioritization here, but I don't think it's inappropriate, given the balance of Positron vs. VS Code use of the extension these days.