Skip to content

Commit 94beade

Browse files
update readme
1 parent a64c3b0 commit 94beade

File tree

2 files changed

+7
-43
lines changed

2 files changed

+7
-43
lines changed

README.md

Lines changed: 6 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -14,45 +14,14 @@ is found within `chain/security`. So the URL for this link will be:
1414

1515
Follow these steps to run Base-Docs locally:
1616

17-
1. Make sure you have installed all dependencies by running `yarn install` at
18-
the top-level of the monorepo
17+
1. Clone repo
1918

20-
2. Start the base-docs workspace with the following command: `yarn workspace @app/base-docs dev`
19+
2. Enable yarn by running `corepack enable`
2120

21+
3. Make sure you have installed all dependencies by running `yarn install` at
22+
the top-level
2223

23-
# Building Docs Locally
24+
4. `yarn build`
2425

25-
Follow these steps to build Base-Docs locally:
26+
4. Start development server by running `yarn dev`
2627

27-
1. Make sure you have installed all dependencies by running `yarn install` at
28-
the top-level of the monorepo
29-
30-
2. Navigate into the base-docs service and then build the Vocs site:
31-
```
32-
cd apps/base-docs
33-
yarn build
34-
```
35-
36-
3. Start the local build: `yarn preview`
37-
38-
39-
# Troubleshooting
40-
41-
You may encounter an error of the form:
42-
```
43-
TypeError: Cannot destructure property 'CookieBanner' of 'pkg' as it is undefined.
44-
```
45-
46-
To resolve this:
47-
1. navigate to `apps/base-docs/docs/contexts/CookieBannerWrapper.tsx`
48-
49-
2. comment out the lines:
50-
```
51-
import pkg from '@coinbase/cookie-banner';
52-
const { CookieBanner } = pkg;
53-
```
54-
55-
3. add the following line:
56-
```
57-
import { CookieBanner } from '@coinbase/cookie-banner';
58-
```

package.json

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,7 @@
66
"dev": "vocs dev",
77
"build": "vocs build",
88
"preview": "vocs preview",
9-
"inject-feedback": "node --loader ts-node/esm scripts/inject-feedback.ts",
10-
"fix-feedback": "node --loader ts-node/esm scripts/fix-feedback-import.ts",
11-
"clean-frontmatter": "node --loader ts-node/esm scripts/clean-frontmatter.ts",
12-
"docs:dev": "vocs dev",
13-
"docs:build": "vocs build",
14-
"docs:preview": "vocs preview"
9+
"clean-frontmatter": "node --loader ts-node/esm scripts/clean-frontmatter.ts"
1510
},
1611
"dependencies": {
1712
"@coinbase/cookie-banner": "^1.0.3",

0 commit comments

Comments
 (0)