Skip to content

Add more docs around migration from RStudio#116

Merged
juliasilge merged 37 commits intomainfrom
rstudio-migration
Aug 19, 2025
Merged

Add more docs around migration from RStudio#116
juliasilge merged 37 commits intomainfrom
rstudio-migration

Conversation

@jennybc
Copy link
Copy Markdown
Member

@jennybc jennybc commented Jul 8, 2025

Addresses posit-dev/positron#7570
Addresses posit-dev/positron#4157
Addresses posit-dev/positron#7558
Partially addresses posit-dev/positron#7208

This is not done, but I've grown a bit sick of it 😬 and I think I'll be able to finish it off best with input from others. I've done a lot of self-review to elicit feedback.

I'm also sure there's a lot of fiddly stuff around Vale, formatting of keyboard shortcuts and phrases like "command palette", etc. Hopefully semi-automated tools will raise and fix (or help me fix) most of that.

@netlify
Copy link
Copy Markdown

netlify bot commented Jul 8, 2025

Deploy Preview for positron-posit-co ready!

Name Link
🔨 Latest commit 5738433
🔍 Latest deploy log https://app.netlify.com/projects/positron-posit-co/deploys/68a3c9496647b00008411418
😎 Deploy Preview https://deploy-preview-116--positron-posit-co.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Comment on lines +14 to +16
Next, let's get concrete by naming the major areas of Positron's surface.

![Major areas of the Positron user interface](images/user-interface-for-rstudio-migration.jpeg){width=700 fig-alt="A screenshot with labelled boxes around the Activity bar, Primary side bar, Editor, Panel, and Secondary sidebar."}
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made this screenshot for the workshop, but I think something awfully close to this would be good here. Same image should probably be used in both this location and the main user interface topic. See below.


*TO DISCUSS: there's another, existing screenshot in the repo that is somewhat equivalent to the second one above. I'll include it here for comparison. We should probably settle on one such image and use it in both places.*

![Existing `user-interface.png`](images/user-interface.png){width=700}
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's a pre-existing screenshot for calling out the different areas.

This comment was marked as outdated.

@jennybc jennybc force-pushed the rstudio-migration branch from 6c8e8ad to ddb2086 Compare July 8, 2025 04:00
@jennybc jennybc marked this pull request as ready for review July 8, 2025 04:09
lionel-
lionel- previously approved these changes Jul 8, 2025
Copy link
Copy Markdown
Contributor

@lionel- lionel- left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LG!

Would it be worthwhile to offer a quick orientation guide on layout/panels, focused on the differences coming from RStudio?

@jennybc
Copy link
Copy Markdown
Member Author

jennybc commented Jul 8, 2025

@lionel- says:

Would it be worthwhile to offer a quick orientation guide on layout/panels, focused on the differences coming from RStudio?

And, yes, I had wondered the same thing. But didn't add due to scope being large enough already. But we could add it here or a new issue. I think we should merge some version of this soon, because it's waaaaaay better than nothing and open issues for further additions or refinement.

@juliasilge juliasilge requested a review from Copilot August 15, 2025 20:15
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR significantly expands the RStudio migration documentation by adding comprehensive guides for users transitioning from RStudio to Positron. The changes reorganize existing content and add substantial new documentation covering the migration experience from multiple angles.

Key changes include:

  • Creation of a comprehensive RStudio migration guide with multiple focused sub-pages
  • Addition of feature comparison documentation between RStudio and Positron
  • Enhanced documentation on settings, extensions, and code writing workflows
  • Reorganization of the navigation structure to better support RStudio users

Reviewed Changes

Copilot reviewed 12 out of 13 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
migrate-rstudio.qmd New overview page introducing RStudio users to Positron's interface and Command Palette
migrate-rstudio-settings-and-extensions.qmd New guide covering settings configuration and extension recommendations for RStudio users
migrate-rstudio-code.qmd Expanded from r-snippets.qmd to cover Air formatting and R code writing workflows
migrate-rstudio-compare.qmd New feature comparison between RStudio and Positron highlighting unique capabilities
migrate-rstudio-keybindings.qmd Enhanced keybinding documentation with updated shortcuts and clearer descriptions
migrate-rstudio-rproj.qmd Added alias for backward compatibility
migrate-vscode.qmd Minor formatting fix and addition of walkthrough callout
keyboard-shortcuts.qmd Updated with additional shortcuts and improved RStudio keybinding references
git.qmd Minor formatting fix
faqs.qmd Updated internal links to use new file names
_quarto.yml Reorganized navigation structure for RStudio migration content
.github/styles/config/vocabularies/posit-docs/accept.txt Added accepted terms for documentation

juliasilge and others added 4 commits August 15, 2025 14:21
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@juliasilge
Copy link
Copy Markdown
Collaborator

We definitely need to get this merged. The GitHub PR UI is starting to have a hard time. 😬

@juliasilge
Copy link
Copy Markdown
Collaborator

@jennybc This is now ready for you to review. Looks like I can't ping you in the regular way, either because this PR has gotten too complex or because you are the original author.

Copy link
Copy Markdown
Member Author

@jennybc jennybc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you so much for completing the merge from hell! I've reread all the stuff I consider "in scope" for this PR (versus the changes merged in from main), in source and rendered form. This is a great step forward and then we can work on a reorg as already discussed.

Morally I approve this PR. Apparently I can't approve because I'm technically an/the author of the PR (?). "Pull request authors can't approve their own pull request."

@@ -2,46 +2,105 @@
title: "Settings and Extensions"
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like what you've done here!

Positron's [user interface](layout.qmd) (UI) should feel familiar to RStudio users, but there are also changes to get used to.
First, let's take a high-level, side-by-side view of the two IDEs.
This figure highlights the role each area plays in your workflow and draws similarities between Positron and RStudio.
You write code in an editor, execute it in the R Console, and view outputs like plots and reports.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence feels a bit unfinished:

You write code in an editor, execute it in the R Console, and view outputs like plots and reports IN SOME OTHER PLACE?

@juliasilge juliasilge merged commit c38de11 into main Aug 19, 2025
5 checks passed
@juliasilge juliasilge deleted the rstudio-migration branch August 19, 2025 00:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants