Add cheatsheet. #131
Merged
Add cheatsheet. #131
Conversation
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
giurgiur99
reviewed
Oct 6, 2025
cheatsheet.md
Outdated
| ## ✅ Requirements | ||
|
|
||
| - VS Code **v1.96.0 or higher** | ||
| - Algorithm file open (`.py` or `.js`) |
Contributor
There was a problem hiding this comment.
No longer needed, we switched to "New project"/"Select project" style
cheatsheet.md
Outdated
|
|
||
| ## 📦 Installation | ||
|
|
||
| 1. Install from [VS Code Marketplace](https://marketplace.visualstudio.com/). |
Contributor
There was a problem hiding this comment.
We can add link to extension, not to marketplace here
cheatsheet.md
Outdated
| 1. Install from [VS Code Marketplace](https://marketplace.visualstudio.com/). | ||
| 2. Open the **Ocean Protocol** panel (left Activity Bar). | ||
| 3. Configure settings: | ||
| - **Node URL** (default provided) |
cheatsheet.md
Outdated
| 2. Open the **Ocean Protocol** panel (left Activity Bar). | ||
| 3. Configure settings: | ||
| - **Node URL** (default provided) | ||
| - **Algorithm file** (mandatory provided) |
Contributor
There was a problem hiding this comment.
"New project"/"Select project" style
cheatsheet.md
Outdated
| - **Node URL** (default provided) | ||
| - **Algorithm file** (mandatory provided) | ||
| - **Results folder** (mandatory provided) | ||
| - (Optional) Custom Docker image/tag |
cheatsheet.md
Outdated
|
|
||
| ## ▶️ Running a Compute Job | ||
|
|
||
| 1. Open an **algorithm file** (`.js` or `.py`). |
cheatsheet.md
Outdated
| 3. Select **Results folder** | ||
| 4. In the **Ocean panel**, click **Start Compute Job**. | ||
| 5. Watch logs & job status in the **Output panel**. | ||
| 6. When finished, results file opens automatically in VS Code. |
Contributor
There was a problem hiding this comment.
They do not pop up anymore, you have the logs in output channel and a copy in results/logs
cheatsheet.md
Outdated
|
|
||
| ## ⚡ Tips | ||
|
|
||
| - **Free compute credits** available for dev/testing. |
Contributor
There was a problem hiding this comment.
Free compute does not require credits
ndrpp
approved these changes
Oct 8, 2025
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.
Fixes #126
Changes proposed in this PR: