Skip to content

Commit 3ddece5

Browse files
committed
fix links
1 parent c6805c4 commit 3ddece5

5 files changed

Lines changed: 10 additions & 7 deletions

File tree

packages/browser-sdk/FEEDBACK.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ See examples below.
269269

270270
![image](https://github.com/bucketco/bucket-tracking-sdk/assets/331790/68805b38-e9f6-4de5-9f55-188216983e3c)
271271

272-
See [default English localization keys](./src/feedback/config/defaultTranslations.tsx)
272+
See [default English localization keys](https://github.com/bucketco/bucket-javascript-sdk/tree/main/packages/browser-sdk/src/feedback/ui/config/defaultTranslations.tsx)
273273
for a reference of what translation keys can be supplied.
274274

275275
### Static language configuration
@@ -389,7 +389,7 @@ For example, a dark mode theme might look like this:
389389
}
390390
```
391391
392-
Other examples of custom styling can be found in our [development example style-sheet](./dev/index.css).
392+
Other examples of custom styling can be found in our [development example style-sheet](https://github.com/bucketco/bucket-javascript-sdk/tree/main/packages/browser-sdk/src/feedback/ui/index.css).
393393
394394
## Using your own UI to collect feedback
395395
@@ -414,7 +414,7 @@ Bucket API.
414414
### Manual feedback collection with custom UI
415415
416416
Examples of a HTML-form that collects the relevant data can be found
417-
in [feedback.html](./example/feedback/feedback.html) and [feedback.jsx](./example/feedback/feedback.jsx).
417+
in [feedback.html](https://github.com/bucketco/bucket-javascript-sdk/tree/main/packages/browser-sdk/example/feedback/feedback.html) and [feedback.jsx](https://github.com/bucketco/bucket-javascript-sdk/tree/main/packages/browser-sdk/example/feedback/Feedback.jsx).
418418
419419
Once you have collected the feedback data, pass it along to `bucketClient.feedback()`:
420420

packages/browser-sdk/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ bucketClient.requestFeedback({ featureKey: "huddle" });
5353

5454
B. Script tag (client-side directly in html)
5555

56-
See [example/browser.html](example/browser.html) for a working example:
56+
See [example/browser.html](https://github.com/bucketco/bucket-javascript-sdk/tree/main/packages/browser-sdk/example/browser.html) for a working example:
5757

5858
```html
5959
<script src="https://cdn.jsdelivr.net/npm/@bucketco/browser-sdk@2"></script>

packages/browser-sdk/typedoc.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"projectDocuments": ["FEEDBACK.md"],
3+
}

packages/node-sdk/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ current working directory.
119119
| `logLevel` | string | The log level for the SDK (e.g., `"DEBUG"`, `"INFO"`, `"WARN"`, `"ERROR"`). Default: `INFO` | BUCKET_LOG_LEVEL |
120120
| `offline` | boolean | Operate in offline mode. Default: `false`, except in tests it will default to `true` based off of the `TEST` env. var. | BUCKET_OFFLINE |
121121
| `apiBaseUrl` | string | The base API URL for the Bucket servers. | BUCKET_API_BASE_URL |
122-
| `featureOverrides` | Record<string, boolean> | An object specifying feature overrides for testing or local development. See [example/app.test.ts](example/app.test.ts) for how to use `featureOverrides` in tests. | BUCKET_FEATURES_ENABLED, BUCKET_FEATURES_DISABLED |
122+
| `featureOverrides` | Record<string, boolean> | An object specifying feature overrides for testing or local development. See [example/app.test.ts](https://github.com/bucketco/bucket-javascript-sdk/tree/main/packages/browser-sdk/example/app.test.ts) for how to use `featureOverrides` in tests. | BUCKET_FEATURES_ENABLED, BUCKET_FEATURES_DISABLED |
123123
| `configFile` | string | Load this config file from disk. Default: `bucketConfig.json` | BUCKET_CONFIG_FILE |
124124

125125
Note: BUCKET_FEATURES_ENABLED, BUCKET_FEATURES_DISABLED are comma separated lists of features which will be enabled or disabled respectively.
@@ -237,7 +237,7 @@ app.get("/todos", async (_req, res) => {
237237
}
238238
```
239239
240-
See [example/app.ts](example/app.ts) for a full example.
240+
See [example/app.ts](https://github.com/bucketco/bucket-javascript-sdk/tree/main/packages/node-sdk/example/app.ts) for a full example.
241241
242242
## Remote flag evaluation with stored context
243243

typedoc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
{
2222
"name": "json",
2323
"path": "./dist/docs/docs.json"
24-
},
24+
},
2525
],
2626
"navigation": {
2727
"includeCategories": false,

0 commit comments

Comments
 (0)