You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: contributor_docs/contributing_to_the_p5js_reference.md
+9-3Lines changed: 9 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1201,6 +1201,8 @@ Steps:
1201
1201
1. Run `npm install`
1202
1202
1. Run the following command, using the path to **your** local p5.js repo before the `#`, and the name of **your** branch after the `#`:
1203
1203
1204
+
(Note the following is a single line, not two lines!)
1205
+
1204
1206
```sh
1205
1207
npm run custom:dev path/to/YOUR/local/repo#yourBranch
1206
1208
```
@@ -1217,6 +1219,8 @@ This will build the local website reference pages from the data in your branch a
1217
1219
1218
1220
If you prefer to preview work that's already on github, you can do so. Use the repo URL instead of its local path, as follows:
1219
1221
1222
+
(Again, note the following is a single line, not two lines!)
1223
+
1220
1224
```sh
1221
1225
npm run custom:dev https://github.com/yourUsername/p5.js.git#yourBranch
1222
1226
```
@@ -1230,10 +1234,12 @@ npm run custom:cleanup
1230
1234
1231
1235
#### Troubleshooting
1232
1236
1233
-
* [Run the documentation linter](#linting-the-docs) on your source files.
1234
1237
* Review the log from the above `custom:dev` process, for mentions of your code.
1235
-
* Don't forget that if you're [using local asset files](#using-assets), they'll need to be in the _website_ repo.
1236
-
* Note that block comments starting with `/*` rather than `/**` will be _ignored_ and won't be used for the reference (even though they may look otherwise identical in your editor).
1238
+
* Don't forget that if you're [using local asset files](#using-assets), they'll need to be in the *website* repo, _not_ the main p5.js repo!
1239
+
* Note that block comments starting with `/*` rather than `/**` will be *ignored* and won't be used for the reference (even though they may look otherwise identical in your editor).
1240
+
* Make sure you've specified the correct branch where your changes are.
1241
+
* Ensure you see in the log that your repo _has_ actually been cloned. There is a caching mechanism in the website build process which prevents a recently cloned repo from being cloned again. Removing the website folder `in/p5.js/` will force the build process to make a new clone.
1242
+
* You can also [Run the documentation linter](#linting-the-docs) on your source files to look for warnings.
0 commit comments