Skip to content

Dev-Docs Update #247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 23, 2024
Merged

Dev-Docs Update #247

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions docs/Create a custom doc using the vscode extension.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@


## Step 1: Navigate to Dev-Docs Panel

Open the Dev-Docs panel in your VS Code extension.

![image for /img/create_a_custom_doc_using_the_vscode_extension/step_1](/img/create_a_custom_doc_using_the_vscode_extension/step_1.png)

## Step 2: Initiate Custom Doc Creation

Click on the "Create Custom Doc" button to start the process.

![image for /img/create_a_custom_doc_using_the_vscode_extension/step_2](/img/create_a_custom_doc_using_the_vscode_extension/step_2.png)

## Step 3: Review Existing Code

Examine the existing code in your project, which may include functions for image processing and sprite generation.

![image for /img/create_a_custom_doc_using_the_vscode_extension/step_3](/img/create_a_custom_doc_using_the_vscode_extension/step_3.png)

## Step 4: Analyze Code Structure

Take a closer look at the structure of your code, including imports and function definitions.

![image for /img/create_a_custom_doc_using_the_vscode_extension/step_4](/img/create_a_custom_doc_using_the_vscode_extension/step_4.png)

## Step 5: Inspect Function Details

Examine the details of specific functions, such as `removeBackgroundColor` and `encodeImage`.

![image for /img/create_a_custom_doc_using_the_vscode_extension/step_5](/img/create_a_custom_doc_using_the_vscode_extension/step_5.png)

## Step 6: Review Additional Functions

Look at other functions in your code, like `getUniqueColors`.

![image for /img/create_a_custom_doc_using_the_vscode_extension/step_6](/img/create_a_custom_doc_using_the_vscode_extension/step_6.png)

## Step 7: Select Documentation File

Choose the "misc-cool-ways-to-use-this-sdk.md" file to document the SDK usage.

![image for /img/create_a_custom_doc_using_the_vscode_extension/step_7](/img/create_a_custom_doc_using_the_vscode_extension/step_7.png)

## Step 8: Document SDK Features

Write documentation outlining the cool ways to use the SDK, including creating custom character sprites, generating unique game environments, and automating spritesheet creation.

![image for /img/create_a_custom_doc_using_the_vscode_extension/step_8](/img/create_a_custom_doc_using_the_vscode_extension/step_8.png)