Skip to content

Commit 5403a65

Browse files
committed
Format and fix dead links in contributing doc
1 parent e53cf6b commit 5403a65

File tree

1 file changed

+27
-29
lines changed

1 file changed

+27
-29
lines changed

docs/contributing.md

Lines changed: 27 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ Thank you for your interest in contributing to theme-tools! Your contributions w
55
## Table of Contents
66

77
- [Setting Up Your Environment](#setting-up-your-environment)
8-
- [Setup for the VS Code Extension](#setup-for-the-vscode-extension)
9-
- [Setup for the Online Store](#setup-for-the-online-store)
108
- [Submitting a Pull Request](#submitting-a-pull-request)
119
- [Reporting Issues](#reporting-issues)
1210
- [Code of Conduct](#code-of-conduct)
@@ -39,10 +37,10 @@ Before you can start contributing to theme-tools, you'll need to set up your dev
3937
```bash
4038
yarn test
4139
```
40+
4241
5. **Start developing**: If you're developing changes to test against the vscode extension, all you need to do is add a breakpoint anywhere in a package used within the VS Code extension, hit `f5` in VS Code and your development instance of theme-check will automatically open.
4342

44-
### Developing for online-store-web
45-
It is strongly recommended that you use the spin constellation: `theme-tools:online-store` as your development environment for this.
43+
### Developing for online-store-web (Shopifolk only)
4644

4745
To set up the package links to online-store-web, within this repo root run: `yarn admin:init`
4846

@@ -54,7 +52,7 @@ Once you've made some changes to your local theme-tools packages, to see those c
5452

5553
Run the following command to start a browser instance that runs `@shopify/theme-language-server-browser`.
5654

57-
```
55+
```bash
5856
yarn playground
5957
```
6058

@@ -80,45 +78,45 @@ If ever you want to see how the VS Code extension or playground would behave bef
8078

8179
1. In a terminal, with VS Code closed, go to the Shopify/theme-liquid-docs directory.
8280

83-
```sh
84-
# Shopifolk
85-
dev cd theme-liquid-docs
81+
```sh
82+
# Shopifolk
83+
dev cd theme-liquid-docs
8684

87-
# External
88-
cd /path/to/theme-liquid-docs
89-
```
85+
# External
86+
cd /path/to/theme-liquid-docs
87+
```
9088

9189
2. Export the root of that repository in the `SHOPIFY_TLD_ROOT` environment variable
9290

93-
```sh
94-
export SHOPIFY_TLD_ROOT=$(pwd)
95-
```
91+
```sh
92+
export SHOPIFY_TLD_ROOT=$(pwd)
93+
```
9694

9795
3. Go to the Shopify/theme-tools directory.
9896

99-
```sh
100-
# Shopifolk
101-
dev cd theme-tools
97+
```sh
98+
# Shopifolk
99+
dev cd theme-tools
102100

103-
# External
104-
cd /path/to/theme-tools
105-
```
101+
# External
102+
cd /path/to/theme-tools
103+
```
106104

107105
4. Update the docs and start VS Code from that directory.
108106

109-
```sh
110-
# update the docs
111-
theme-docs download
107+
```sh
108+
# update the docs
109+
theme-docs download
112110

113-
# start vscode
114-
code .
115-
```
111+
# start vscode
112+
code .
113+
```
116114

117115
5. (Repeat) You can repeat the `theme-docs download` command to have updated changes.
118116

119-
```sh
120-
theme-docs download
121-
```
117+
```sh
118+
theme-docs download
119+
```
122120

123121
6. Proceed to debug the VS Code extension or playground as usual.
124122

0 commit comments

Comments
 (0)