File tree Expand file tree Collapse file tree 1 file changed +4
-2
lines changed
Expand file tree Collapse file tree 1 file changed +4
-2
lines changed Original file line number Diff line number Diff line change @@ -21,14 +21,16 @@ Help improve the Photobooth docs by following these steps.
2121
2222## 3) Run the docs locally
2323
24- - From the repo root, start the preview server:
24+ - From the repo root, build the docs and start the preview server:
2525 ```
26- mkdocs serve -f mkdocs_remote.yml
26+ mkdocs build --config-file mkdocs_remote.yml --site-dir faq
27+ mkdocs serve -f mkdocs_remote.yml --site-dir faq
2728 ```
2829- Open the URL shown in the terminal (typically ` http://127.0.0.1:8000 ` ) to review your changes live.
2930
3031## 4) Edit guidelines
3132
33+ - Don't commit changes to the ` faq/ ` directory directly; it's generated from the ` docs/ ` source files during the build step.
3234- Keep text concise and practical; prefer short paragraphs and bullet lists.
3335- Use relative links to other docs pages (e.g. ` faq/index.md ` ), and ensure new pages are added to ` mkdocs_remote.yml ` .
3436- Place new images in ` docs/assets/ ` and reference them with relative paths.
You can’t perform that action at this time.
0 commit comments