Skip to content

Commit 3d2c41d

Browse files
committed
moved troubleshooting section to contribution guide
1 parent 0d328a8 commit 3d2c41d

File tree

2 files changed

+49
-47
lines changed

2 files changed

+49
-47
lines changed

CONTRIBUTING.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,55 @@ Visit `http://localhost:3000` to preview your changes.
7777

7878
---
7979

80+
## Troubleshooting
81+
82+
### Command failed: ps cax -o command...
83+
84+
While running `npm start` you may run into a this error. This happens because of a bug that prevents docusaurus from starting on macOS computers without a Chrome/Chromium browser installed (or haven't opened one in a while). To fix this error, you can either run the update command in the error message or open a Chrome/Chromium tab.
85+
86+
#### Error details
87+
88+
```
89+
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
90+
91+
Update available 3.8.0 → 3.8.1
92+
93+
To upgrade Docusaurus packages with the latest version, run the following command:
94+
`npm i @docusaurus/core@latest @docusaurus/plugin-client-redirects@latest @docusaurus/plugin-google-analytics@latest @docusaurus/plugin-google-tag-manager@latest @docusaurus/preset-classic@latest
95+
@docusaurus/module-type-aliases@latest @docusaurus/types@latest`
96+
97+
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
98+
99+
[INFO] Starting the development server...
100+
[SUCCESS] Docusaurus website is running at: http://localhost:3000/
101+
102+
● Client █████████████████████████ building (10%) 0/3 entries 2/3 dependencies 0/2 modules 1 active
103+
node_modules/webpack-dev-server/client/index.js
104+
105+
106+
[ERROR] Error: Command failed: ps cax -o command | grep -E "^(Google Chrome Canary|Google Chrome Dev|Google Chrome Beta|Google Chrome|Microsoft Edge|Brave Browser|Vivaldi|Chromium)$"
107+
108+
at genericNodeError (node:internal/errors:983:15)
109+
at wrappedFn (node:internal/errors:537:14)
110+
at ChildProcess.exithandler (node:child_process:414:12)
111+
at ChildProcess.emit (node:events:518:28)
112+
at maybeClose (node:internal/child_process:1101:16)
113+
at Socket.<anonymous> (node:internal/child_process:456:11)
114+
at Socket.emit (node:events:518:28)
115+
at Pipe.<anonymous> (node:net:351:12) {
116+
code: 1,
117+
killed: false,
118+
signal: null,
119+
cmd: 'ps cax -o command | grep -E "^(Google Chrome Canary|Google Chrome Dev|Google Chrome Beta|Google Chrome|Microsoft Edge|Brave Browser|Vivaldi|Chromium)$"',
120+
stdout: '',
121+
stderr: ''
122+
}
123+
[INFO] Docusaurus version: 3.8.0
124+
Node version: v22.16.0
125+
```
126+
127+
---
128+
80129
## Docs Structure Overview
81130

82131
- `docs/` – Markdown files for core documentation

README.md

Lines changed: 0 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -30,53 +30,6 @@ After forking and cloning the repository:
3030
```
3131
3. Open your browser and visit `http://localhost:3000`
3232

33-
## Troubleshooting
34-
35-
### Command failed: ps cax -o command...
36-
37-
While running `npm start` you may run into a this error. This happens because of a bug that prevents docusaurus from starting on macOS computers without a Chrome/Chromium browser installed (or haven't opened one in a while). To fix this error, you can either run the update command in the error message or open a Chrome/Chromium tab.
38-
39-
#### Error details
40-
41-
```
42-
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
43-
44-
Update available 3.8.0 → 3.8.1
45-
46-
To upgrade Docusaurus packages with the latest version, run the following command:
47-
`npm i @docusaurus/core@latest @docusaurus/plugin-client-redirects@latest @docusaurus/plugin-google-analytics@latest @docusaurus/plugin-google-tag-manager@latest @docusaurus/preset-classic@latest
48-
@docusaurus/module-type-aliases@latest @docusaurus/types@latest`
49-
50-
------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
51-
52-
[INFO] Starting the development server...
53-
[SUCCESS] Docusaurus website is running at: http://localhost:3000/
54-
55-
● Client █████████████████████████ building (10%) 0/3 entries 2/3 dependencies 0/2 modules 1 active
56-
node_modules/webpack-dev-server/client/index.js
57-
58-
59-
[ERROR] Error: Command failed: ps cax -o command | grep -E "^(Google Chrome Canary|Google Chrome Dev|Google Chrome Beta|Google Chrome|Microsoft Edge|Brave Browser|Vivaldi|Chromium)$"
60-
61-
at genericNodeError (node:internal/errors:983:15)
62-
at wrappedFn (node:internal/errors:537:14)
63-
at ChildProcess.exithandler (node:child_process:414:12)
64-
at ChildProcess.emit (node:events:518:28)
65-
at maybeClose (node:internal/child_process:1101:16)
66-
at Socket.<anonymous> (node:internal/child_process:456:11)
67-
at Socket.emit (node:events:518:28)
68-
at Pipe.<anonymous> (node:net:351:12) {
69-
code: 1,
70-
killed: false,
71-
signal: null,
72-
cmd: 'ps cax -o command | grep -E "^(Google Chrome Canary|Google Chrome Dev|Google Chrome Beta|Google Chrome|Microsoft Edge|Brave Browser|Vivaldi|Chromium)$"',
73-
stdout: '',
74-
stderr: ''
75-
}
76-
[INFO] Docusaurus version: 3.8.0
77-
Node version: v22.16.0
78-
```
79-
8033
## Structure
8134

8235
- `docs/`: Contains all the markdown files for the documentation

0 commit comments

Comments
 (0)