Skip to content

Commit 102fb87

Browse files
authored
Add some troubleshooting instructions
This adds some troubleshooting instructions to the docs-builder install doc.
1 parent 7941c79 commit 102fb87

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

docs/contribute/locally.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,15 @@ This guide uses the first option. If you'd like to clone the repository and buil
6666

6767
3. **Run the Binary:**
6868
Use the `serve` command to start serving the documentation at http://localhost:3000. The path to the `docset.yml` file that you want to build can be specified with `-p`:
69+
6970
```sh
7071
.\docs-builder serve -p ./path/to/docs
7172
```
7273

74+
:::{tip}
75+
Place the `docs-builder` binary file in a system path so that you can run it from any folder. On Windows, you can do this by running `Copy-Item "docs-builder.exe" -Destination "%SystemRoot%\system32"` with elevated privileges, or move it to a new folder and add the folder to the system paths.
76+
:::
77+
7378
:::
7479

7580
:::{tab-item} Linux
@@ -92,13 +97,17 @@ This guide uses the first option. If you'd like to clone the repository and buil
9297
./docs-builder serve -p ./path/to/docs
9398
```
9499

100+
If you get a `Permission denied` error, make sure that you aren't trying to run a directory instead of a file. Also, grant the binary file execution permissions using `chmod +x docs-builder`.
101+
102+
:::{tip}
103+
Place the `docs-builder` binary file in a system path so that you can run it from any folder. On macOS and Linux, you can do this by running `sudo mv docs-builder /usr/local/bin/docs-builder`.
104+
:::
105+
95106
:::
96107

97108
::::
98109

99-
:::{tip}
100-
Place the `docs-builder` binary file in a system path so that you can run it from any folder. On macOS, you can do this by running `sudo mv docs-builder /usr/local/bin/docs-builder`.
101-
:::
110+
102111

103112
## Clone a content repository [#step-two]
104113

0 commit comments

Comments
 (0)