[skip ci] test

Author: heyzec

README.md

@@ -1,31 +1,58 @@
-# VS Code
+# Source Academy & VS Code
 
-Experimental project for running Source Academy within Visual Studio Code.
+<p align="center">
+   <img src="./assets/icon.png" width="150">
+</p>
 
-## How to use
+A Visual Studio Code extension for integration with [Source Academy](https://about.sourceacademy.org), an online experiential environment for computational thinking.
 
-TODO: Add instructions
+It is available in the VS Code [Extension Marketplace](https://marketplace.visualstudio.com/items?itemName=source-academy.source-academy).
 
-## Notes to developers
+## Features
 
-### Running the extension in dev mode
+- View, edit, and submit assessments
+- Syntax highlighting for Source
+- Integration with our [language server for Source](https://github.com/source-academy/source-lsp), which provides smart features such as:
+  - Error checking
+  - Code completion
+  - Hover documentation
 
-1. Setup the project
-   ```
-   yarn
-   ```
-1. Compile
-   ```
-   yarn compile
-   ```
-1. Run the extension in debug mode by opening the root folder a VSCode window, then "Start Debugging" (or press F5).
+## Installing
 
-### Publishing the extension
+If you don't have VS Code installed yet, download it from [here](https://code.visualstudio.com/docs/setup/setup-overview) first.
 
-For a new release, update the version in `package.json` and tag the commit. Push the commit and the tag to the repo,
-which will trigger GitHub Actions to build and publish the extension to Releases tab and the Marketplace.
+From within VS Code,
+
+1. Click on the Extensions icon on the left sidebar or the `View: Show Extensions` command (`Ctrl+Shift+X`).
+2. Search for "Source Academy" and install it.
+
+We'd recommend also installing the [Error Lens](https://marketplace.visualstudio.com/items?itemName=usernamehw.errorlens) extension
+to show diagnostic messages more prominently.
+
+## Getting started
+
+_If you don't have an existing Source Academy account, you can try out our public frontend. See section [Changing the frontend](#changing-the-frontend)._
+
+After installing the extension,
+
+1. Click on the newly-added Source Academy icon on the left sidebar.
+2. Launch the Source Academy panel.
+
+<img src="./starting.png" width="600">
+
+Alternatively, use the `Source Academy: Show the Source Academy Panel` command.
+
+Once the panel loads, you'll be prompted to log in. Afterwards, begin coding by opening any assessment.
+
+### Changing the frontend
+
+To use a different Source Academy frontend, modify the Frontend Base URL setting:
+
+1. Press `Ctrl + ,` to open VS Code's settings page, then search for `frontendBaseUrl`.
+2. Enter a valid URL.
+
+Example value (public frontend):
 
 ```
-npm version (major|minor|patch)
-git push origin main --tags
+https://sourceacademy.org
 ```

docs/README.md

@@ -0,0 +1,23 @@
+## Notes to developers
+
+### Running the extension in dev mode
+
+1. Setup the project
+   ```
+   yarn
+   ```
+1. Compile
+   ```
+   yarn compile
+   ```
+1. Run the extension in debug mode by opening the root folder a VSCode window, then "Start Debugging" (or press F5).
+
+### Publishing the extension
+
+For a new release, update the version in `package.json` and tag the commit. Push the commit and the tag to the repo,
+which will trigger GitHub Actions to build and publish the extension to Releases tab and the Marketplace.
+
+```
+npm version (major|minor|patch)
+git push origin main --tags
+```

docs/developer-guide.md

@@ -0,0 +1,70 @@
+# Developer Guide
+
+We place developer-facing stuff here because the README.md in the root will be displayed on VS Code Marketplace.
+
+## Setting up project locally
+1. Clone this repo
+2. Assume yarn installed. Assume node installed.
+
+For Nix users, step 2
+- If you have nix-direnv installed, no need anything
+- Else, enter with nix develop
+
+## Running the extension (in?)
+1. Setup the project
+   ```
+   yarn
+   ```
+1. Compile
+   ```sh
+   yarn compile
+   ```
+1. Run the extension in debug mode by opening the root folder in VS Code, then "Start Debugging" (or press F5). Under the hood, this is will compile the extension by running `yarn compile`.
+
+Alternatively, install a compiled version of the extension.
+
+```sh
+yarn compile
+code --profile "Default" --install-extension source-academy-*.vsix --force
+```
+
+## Publishing the extension
+
+For a new release, update the version in `package.json` and tag the commit. Push the commit and the tag to the repo,
+which will trigger GitHub Actions to build and publish the extension to Releases tab and the Marketplace.
+
+```sh
+npm version (major|minor|patch)
+git push origin main --tags
+```
+
+What else?
+- Key points from my FYP report, including architecture
+- For extension: tip to console.log, using debugger
+- Instructions for local frontend (tip: how to log), and for LSP (tip: how to log)
+- ensure vscode version
+```
+"engines": {
+    "vscode": "^1.93.0"
+  },
+```
+
+it is my beleif that we should have good dev experience
+
+note to developers: if following vscode debug setup doesn't work, this is a documentation bug. if you are sure you followed the steps correctl,y please raise an issue
+
+it is my beleif that we should have good dev experience
+
+iamge to readme, user facing
+
+About debuggin in vscode is supported for VS Code, but not neovim.
+
+add exrc for neovim
+
+sugested extensions: both to user and to developer
+
+## Archi
+Delegation to frontend
+js-slang in frontend
+Extension context and Webview context
+Drawing from STEPS

package.json

@@ -5,7 +5,10 @@
   "license": "Apache-2.0",
   "displayName": "Source Academy",
   "description": "VS Code extension for Source Academy",
-  "repository": "https://github.com/source-academy/vscode",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/source-academy/vscode"
+  },
   "categories": [
     "Programming Languages",
     "Education"

src/extension.ts

@@ -27,6 +27,9 @@ export function activate(context: vscode.ExtensionContext) {
   // };
   const info = context.globalState.get("info") ?? {};
 
+  context.globalState.update("assessmentOverviews", undefined)
+  context.globalState.update("courseId", undefined)
+
   client.sendRequest("source/publishInfo", info);
 
   SOURCE_ACADEMY_ICON_URI = vscode.Uri.joinPath(