[eitsupi]

Related to #1755

Adds a documentation site in website/ and ports the wiki pages into it. The extension stays at the repository root; website/ is a standalone pnpm project with its own lockfile, so the extension's dependencies, VSIX contents, and existing workflows are unchanged.

Why VitePress

• The wiki is plain Markdown reference material, and VitePress renders it almost as is: sidebar, per-page outline, built-in local full-text search (no external service or API key), "Edit this page" links, and last-updated timestamps.
• It runs on the Node.js/pnpm toolchain this repository already uses. Zensical was ruled out because it would add a Python runtime.
• Astro Starlight is a good alternative but more than a site of this size needs.
• While q2 (Quarto 2) is familiar to R users, the developers themselves consider it still experimental.

What is included

• 22 wiki pages moved to regular paths (for example Installation:-Windows -> installation/windows.md), with wiki links rewritten to relative links. The build fails on dead internal links.
• Small corrections made while porting: the minimum VS Code version (1.101), the R Interactive note (released in 3.2.0), a few links that were already broken in the wiki, and a Contributing page that now points to CONTRIBUTING.md instead of the outdated yarn/eslint steps.
• .github/workflows/pages.yml builds the site for changes under website/. It deploys to GitHub Pages on pushes to main (see Deployment after merge below).
• R logo attribution (CC BY-SA 4.0) in the site footer and ThirdPartyNotices.txt.

Images

Screenshots still reference the GitHub-hosted URLs used by the wiki (user-images.githubusercontent.com, github.com/user-attachments). All 40 currently load, but they are outside the repository and the build cannot detect if one disappears. They are not vendored here because they total about 77 MB, of which 14 GIFs account for about 70 MB. This should be revisited later, for example by vendoring the PNGs (about 7 MB) and re-recording or converting the GIFs to video.

Follow-ups

• Update the wiki links in README.md, CONTRIBUTING.md, and the source once the site is live, and add a pointer to the new site in the wiki.

To preview locally: cd website && pnpm install --frozen-lockfile && pnpm run docs:dev.

Deployment after merge

The deploy job is enabled, but GitHub Pages is not yet enabled for this repository, so the first pages run on main after merging will fail at the deploy step. This does not affect the extension build or release. To publish the site:

1. A repository admin sets Settings > Pages > Build and deployment > Source to GitHub Actions.
2. Run the pages workflow manually (Actions > pages > Run workflow on main). The workflow only runs on pushes that touch website/**, so the site is not published until it is triggered this way or by the next site change. (Re-running the failed job also works only while the uploaded artifact is still retained, one day by default.)
3. Optionally check that the github-pages environment only allows deployments from main.

[renkun-ken]

Reviewed commit 3a30212. No blocking issues found.

Validation:

• Installed the standalone website project with pnpm install --frozen-lockfile and successfully ran pnpm run docs:build.
• Compared the migrated pages with the wiki: substantive content is preserved, and the version/release corrections agree with the repository sources.
• Audited the rendered output: all 932 internal links and fragments across 25 HTML pages resolve, and local image paths are valid.
• Verified local search, navigation to a search-result anchor, and mobile sidebar navigation in the production preview.
• Checked the Pages workflow, separate pnpm workspace/lockfile, and extension packaging exclusions; the website remains isolated from the extension.
• All eight hosted checks passed for this head.

Live GitHub Pages deployment remains untested because the deploy job is intentionally disabled pending repository configuration, as documented in the PR.

[eitsupi]

@renkun-ken I've enabled the deployment job.
Could you please enable GitHub Pages?

I think we'll also need to change the repository details after deployment (I don't have the necessary permissions).

[renkun-ken]

@eitsupi I've enabled GitHub Pages for this repo.

[renkun-ken]

@eitsupi I've invited you in collaborators, not sure if you have necessary permissions to do that?

[eitsupi]

Thank you.
Unfortunately, it seems I don't have sufficient permissions. Perhaps administrator privileges are required?

[eitsupi]

Looks good.
https://reditorsupport.github.io/vscode-R/

Perhaps for the next step, we should restrict wiki updates to collaborators and add a notice on each page directing users to the website.
I’m currently out, so I’ll take a look at this later.

[eitsupi]

@renkun-ken I believe I've updated all the pages on the wiki. Could you please lock the wiki so that only administrators can update it?

[eitsupi]

@renkun-ken @randy3k Could you update the Wiki settings and the repo details?