Repository navigation
docs: point the README to the documentation site - #1948
Merged
Merged
Conversation
Add release channels and installation steps to Getting Started, move the data viewer details and recommended console/plot setup from the README, document the native plot backend, and update R Interactive requirements for the pure R sess package.
Replace wiki links with the documentation site, use static badges for the documentation and both registries, and describe daily pre-releases accurately.
Interactive sessions require arf and cannot answer console input or debugger prompts, as the README previously noted. Also clarify when scheduled pre-releases are skipped.
Fred-Wu
approved these changes
Nov 15, 2026
| The R host needs: | ||
|
|
||
| - R, plus either compatible pre-built sess/dependency packages or a C compiler capable of building R packages (`r-base-dev` and `build-essential` on Debian/Ubuntu). | ||
| - R. The bundled sess package is pure R and needs no compiler; its missing Imports are installed from the configured R repository. |
Contributor
There was a problem hiding this comment.
A non-blocking suggestion: could we clarify that missing dependencies may require build tools when installed from source, as is usual on Linux?
Otherwise, no issues found.
eitsupi
force-pushed
the
docs/readme-website
branch
from
November 15, 2026 08:05
2324ce6 to
c923a56
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
The documentation now lives on the documentation site, but the README still linked to the GitHub wiki throughout, duplicated detailed feature documentation, and described daily pre-releases inaccurately (it said they were published whenever
mainchanged, which is how the GitHublatestdevelopment build works, not the registry pre-releases). Some README-only information was also missing from the site, and a few site pages had drifted from the implementation.Summary
README:
img.shields.io/visual-studio-marketplace/...now renders "retired badge"), so the Marketplace version cannot be shown. The previous "release" badge worked around this with the GitHub release version but linked to the Marketplace.package.jsononmain, which is not the version of any published pre-release.3.5.20261115) rather than the stable version.CONTRIBUTING.md: replaced the two wiki links with documentation site pages.
Other wiki links: the R Interactive links in
sess/README.mdandsrc/interactive/README.md, and the R Markdown templates link that the template picker opens (src/rmarkdown/draft.ts), now point to the documentation site.Documentation site:
latestdevelopment build.settings.json.nativeplot backend, replacing the advice to disable the session watcher to use R's own graphics device.Package names and arf are written in plain text in new prose, following the tidyverse style guide. Existing text is left as is.
Follow-up
Left for separate changes:
httpgd" in the plot viewer page andlanguageserverin the installation guides), against the tidyverse style guide. This affects most pages underwebsite/docs/(configuration, features, guide, and installation) andCONTRIBUTING.md. Setting values such as thejgdoption ofr.plot.backendshould stay as code.package.jsonsetting descriptions, which appear in the VS Code settings UI, and in messages and comments underR/andsess/.