Skip to content

Commit a83a402

Browse files
committed
update scripts doc
1 parent fe82394 commit a83a402

1 file changed

Lines changed: 8 additions & 4 deletions

File tree

docs/scripts.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# Scripts
1+
# Content Scripts
22

33
This repo includes a few scripts to pull content from external sources, primarily the [p5.js repo](https://github.com/processing/p5.js).
44

55
They are all runnable via npm scripts.
66

7-
## Search Indices Build Script
7+
## After a p5.js release
88

9-
`npm run build:search` generates metadata about the content of the website so the search functionality can show relevant results.
9+
To update the content on the p5.js website following a new release of p5.js, you should run all of these commands to pull in the latest content. **Be sure to run the search indices script last as it depends on the results of the other scripts to be accurate.**
1010

1111
## Contributor Docs Build Script
1212

13-
`npm run build:contributor-docs` copies the contributor docs from the p5.js website repo and places them into the [contributor docs content collection](/src/content/contributor-docs).
13+
`npm run build:contributor-docs` copies the contributor docs from the p5.js repo and places them into the [contributor docs content collection](/src/content/contributor-docs).
1414

1515
## Reference Build Script
1616

@@ -19,3 +19,7 @@ They are all runnable via npm scripts.
1919
## Contributors List Build Script
2020

2121
`npm run build:contribtuors` parses the list of contributors from the all contributors [config file](https://github.com/processing/p5.js/blob/main/.all-contributorsrc) in the p5.js repo and adds entries in the [people collection](src/content/people/en) for anyone who is missing. These are used to render the list of contributors on the [People page](https://p5js.org/people/). This script will **not** remove or update existing entries, that must be done manually.
22+
23+
## Search Indices Build Script
24+
25+
`npm run build:search` generates metadata about the content of the website so the search functionality can show relevant results. This script should usually be run after any of the above scripts are run.

0 commit comments

Comments
 (0)