Skip to content

Commit

Permalink
Moved images
Browse files Browse the repository at this point in the history
  • Loading branch information
breezy-codes committed Oct 24, 2024
1 parent e8c3353 commit 865fcf1
Show file tree
Hide file tree
Showing 24 changed files with 28 additions and 20 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ you have added the [Astro Extension](https://docs.astro.build/en/editor-setup/)
To get started working within the Starlight.io you need to first head over to GitHub and make your
own fork of the [Splashkit Repo](https://github.com/thoth-tech/splashkit.io-starlight).

![splashkit repo](/splashkit/onboarding/starlightrepo.png)
![splashkit repo](./images/starlightrepo.png)

Then select the fork button and create the fork:

![splashkit fork](/splashkit/onboarding/splashkitfork.png)
![splashkit fork](./images/splashkitfork.png)

### Steps to Clone the Repo

Expand All @@ -54,15 +54,15 @@ Now you're all set up to start working on the Splashkit.io repo.
Open a new vscode window, and then open the command palette by pressing `cmd + shift + p`, then type
`git clone` and paste the URL of your forked repo.

![splashkit repo](/splashkit/onboarding/gitclone.gif)
![splashkit repo](./images/gitclone.gif)

When prompted select the folder location you want to clone the repo into.

![splashkit repo](/splashkit/onboarding/cloningrepo.png)
![splashkit repo](./images/cloningrepo.png)

Once the repo is cloned, vscode will prompt you to open the repo folder location.

![splashkit repo](/splashkit/onboarding/openrepo.png)
![splashkit repo](./images/openrepo.png)

Now you're all set up to start working on the Splashkit.io repo in vscode.

Expand All @@ -71,12 +71,12 @@ Now you're all set up to start working on the Splashkit.io repo in vscode.

Open up GitHub Desktop and click on the `File` tab in the top left corner, then select `Clone Repository`.

![splashkit repo](/splashkit/onboarding/clonegitdesk.png)
![splashkit repo](./images/clonegitdesk.png)

Here you can either filter via your existing repositories or find the forked repo, or paste the URL
of the forked repo.

![splashkit repo](/splashkit/onboarding/cloneurlgitdesk.png)
![splashkit repo](./images/cloneurlgitdesk.png)

Once the repo is cloned, you can open the repo in your preferred code editor.

Expand Down Expand Up @@ -111,16 +111,16 @@ Now you're all set up to start working on your new branch.
Open source control by clicking on the icon on the left-hand side of the vscode window. Then select
on the three dots, go down to branch and select `Create Branch from`.

![splashkit repo](/splashkit/onboarding/newbranch-vscode.png)
![splashkit repo](./images/newbranch-vscode.png)

Then select to make the new branch from `master` and name your branch.

![splashkit repo](/splashkit/onboarding/addbranch-vscode.png)
![splashkit repo](/splashkit/onboarding/namebranch-vscode.png)
![splashkit repo](./images/addbranch-vscode.png)
![splashkit repo](./images/namebranch-vscode.png)

Next, push the branch to your fork by clicking on the `Publish Branch` button in source control.

![splashkit repo](/splashkit/onboarding/publishbranch-vscode.png)
![splashkit repo](./images/publishbranch-vscode.png)

Now you're all set up to start working on your new branch.

Expand All @@ -129,15 +129,15 @@ Now you're all set up to start working on your new branch.

Select the Starlight repo in GitHub Desktop, then click on the `Current Branch` tab and select `New Branch`.

![splashkit repo](/splashkit/onboarding/addbranch-gitdesk.png)
![splashkit repo](./images/addbranch-gitdesk.png)

Name your branch and then click `Create Branch`.

![splashkit repo](/splashkit/onboarding/namebranch-gitdesk.png)
![splashkit repo](./images/namebranch-gitdesk.png)

Then push the branch to your fork by clicking on the `Publish Branch` button.

![splashkit repo](/splashkit/onboarding/publishbranch-gitdesk.png)
![splashkit repo](./images/publishbranch-gitdesk.png)

Now you're all set up to start working on your new branch.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ extension in vscode.
Open GitHub and navigate to the repository where you want to create a pull request. Click on the
"Pull requests" tab and then click on the "New pull request" button.

![pull request](/splashkit/onboarding/pull-request-fig1.png)
![pull request](./images/pull-request-fig1.png)

#### 2. Change to the Correct Repository

Expand All @@ -64,16 +64,16 @@ the page.
- **Base Repository**: Set this to `thoth-tech/splashkit.io-starlight`.
- **Base Branch**: Set this to `main`.

![pull request](/splashkit/onboarding/pull-request-fig2.png)
![pull request](./images/pull-request-fig2.png)

![pull request](/splashkit/onboarding/pull-request-fig3.png)
![pull request](./images/pull-request-fig3.png)

#### 3. Add Pull Request Template

Use the pull request template to provide detailed information about your request. Make sure to fill
out all necessary fields and complete any required checks.

![pull request](/splashkit/onboarding/pull-request-fig4.png)
![pull request](./images/pull-request-fig4.png)

#### 4. Submit Your Pull Request

Expand All @@ -88,7 +88,7 @@ give you the option to select the branch you want to create the pull request fro
you want to merge into. Follow the same steps as above to fill out the template and submit the pull
request.

![pull request](/splashkit/onboarding/prinvscode.gif)
![pull request](./images/prinvscode.gif)

### Next Steps

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,3 +53,11 @@ guide for detailed instructions.
- **Mentor Review:** After approving the PR, move it to the appropriate "Mentor Review" column.
- **Comment on approval:** As before, leave a comment with the date and a note indicating you've
approved the task for mentor review.

### 6. Mentor Review

- **Final review:** The mentor will review the task and provide feedback.
- **Request changes:** If changes are needed, the mentor will request them and move the task back to
the "doing" column.
- **Approval:** Once the mentor approves the task, they will merge the PR and move the task to the
"completed" column.
File renamed without changes
File renamed without changes
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ to keep the program minimal while clearly showing how the function works.
For instance, the `write_line` example on the Splashkit site shows how the `write_line`
function works, with a brief explanation, program code, and a screenshot of the output.

![splashkit repo](/splashkit/documentation/usageexample1.png)
![splashkit repo](./images/usageexample1.png)

### Steps to Create a Usage Example

Expand Down

0 comments on commit 865fcf1

Please sign in to comment.