Skip to content

Commit 36a469a

Browse files
committed
Auto merge of #2652 - jsha:document-background-worker, r=JohnTitor
Document running the background worker. This is necessary for uploaded crates to properly display their READMEs.
2 parents ce5696f + 3261a83 commit 36a469a

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -350,6 +350,12 @@ with `CTRL-C` and rerun this command every time you change the backend code):
350350
cargo run --bin server
351351
```
352352
353+
Then start the background worker (which will process uploaded READMEs):
354+
355+
```
356+
cargo run --bin background-worker
357+
```
358+
353359
Then start a frontend that uses this backend by running this command in another
354360
terminal session (the frontend picks up frontend changes using live reload
355361
without a restart needed, and you can leave the frontend running while you

0 commit comments

Comments
 (0)