update docs

Author: phuongdnguyen

docs/README.md

@@ -12,8 +12,7 @@ This plugin enables debugging of Temporal workflows.
 
 ## Quick Start
 
-1. Install the plugin in GoLand.
-2. Configure tdlv path and debug directory in settings.
-3. Upload workflow history JSON in the tool window.
-4. Set breakpoints on events.
-5. Click Run to start debugging. 
+1. Install the plugin.
+2. Upload workflow history JSON in the tool window.
+3. Set breakpoints on events.
+4. Click Run to start debugging. 

docs/architecture.md

@@ -8,7 +8,7 @@ The plugin consists of an IDE Debugging UI, service layer, and `tdlv` integratio
 
 - IDE Debugging UI: Panel for history upload and set breakpoints.
 - IDE Debugging Service: provide api for the Debugger to retrieve the uploaded history & breakpoints.
-- Debugger (`tdlv`): Communicates with language debugger (think Delve, Js-Debug, Debugpy) to intercept debugging event, if a breakpoint is hit, the Debugger notifies the IDE Debugging Service to highlight the event that has its breakpoint hit.
+- Debugger (`tdlv`): Communicates with language debugger (think Delve, Js-Debug, Debugpy) to intercept debugging event. If a breakpoint is hit, the Debugger notifies the IDE Debugging Service to highlight the event that has its breakpoint hit.
 - Adapter: Adapter places sentinel breakpoints inside Temporal workflow/activity interceptors.
 
 

docs/developer-guide.md

@@ -4,22 +4,18 @@
 
 - Clone repository.
 - Build custom-debugger: `go build` in custom-debugger/.
-- Build plugin: `./gradlew buildPlugin` in jetbrains-plugin/.
-
+- Build Jetbrainsplugin: see [jetbrains plugin readme](../jetbrains-plugin/README.md)
+- Build vscode extension: see [vscode extension readme](../vscode-debugger-extension/README.md)
 ## Structure
 
 - custom-debugger/: Intercept message from language debugger.
-- jetbrains-plugin/: GoLand Plugin.
-- replayer-adapter-go/: Inject sentinel breakpoint for Temporal Go SDK.
-- replayer-adapter-python/: Inject sentinel breakpoint for Temporal Python SDK.
-- replayer-adapter-nodejs/: Inject sentinel breakpoint for Temporal Typescript SDK.
+- jetbrains-plugin/: Jetbrains Plugin (support Go).
+- vscode-debugger-extension: Vscode Extension (support Go, Python, Js/TS).
+- replayer-adapter-go/: Inject sentinel breakpoints for Temporal Go SDK.
+- replayer-adapter-python/: Inject sentinel breakpoints for Temporal Python SDK.
+- replayer-adapter-nodejs/: Inject sentinel breakpoints for Temporal Typescript SDK.
 - example/: Test workflows.
 
-## Testing
-
-- Run plugin in sandbox GoLand.
-- Test with example workflows.
-
 ## Contributing
 
 - Fork and branch from main.

docs/user-guide.md

@@ -1,7 +1,7 @@
 # User Guide
 
 ## Overview
-There are 2 methods to use the debugger: standalone & ide integrated
+The major usecase of this software is via the IDE UI. There are 2 plugins supported for VSCode (support go, ts & python workflows) & Jetbrains Plugin (support go workflows)
 
 ## Tested language version
 - Go 1.19+.
@@ -11,17 +11,10 @@ There are 2 methods to use the debugger: standalone & ide integrated
 
 ## Installation
 For both methods:
-1. Install tdlv from [Github Release](https://github.com/phuongdnguyen/temporal-workflow-debugger/releases).
-For Goland Plugin users:
-1. Install the plugin from [jetbrains marketplace](https://plugins.jetbrains.com/search?excludeTags=internal&products=androidstudio&products=aqua&products=clion&products=dataspell&products=dbe&products=fleet&products=go&products=idea&products=idea_ce&products=mps&products=phpstorm&products=pycharm&products=rider&products=ruby&products=rust&products=webstorm&products=writerside&search=Temporal%20workflow%20debugger)
+- Install tdlv from [Github Release](https://github.com/phuongdnguyen/temporal-workflow-debugger/releases).
+For Jetbrains Plugin users:
+- Install the plugin from [jetbrains marketplace](https://plugins.jetbrains.com/search?excludeTags=internal&products=androidstudio&products=aqua&products=clion&products=dataspell&products=dbe&products=fleet&products=go&products=idea&products=idea_ce&products=mps&products=phpstorm&products=pycharm&products=rider&products=ruby&products=rust&products=webstorm&products=writerside&search=Temporal%20workflow%20debugger)
+- Install the plugin from [vscode marketplace](https://updateme)
 
 ## Usage
-For standalone mode users:
-You will need a remote debugging configuration. We have examples provided in [example](../example)
-
-For Goland Plugin users:
-1. Open tool window: View > Tool Windows > Temporal Workflow Debugger.
-2. Upload history: Click 'Upload Workflow History', select JSON file.
-3. Configure: Set debug directory and tdlv path if needed.
-4. Set breakpoints: Click gutter icons in history list.
-5. Start debug: Click 'Run'.
+Examples are provided in [example](../example)