Skip to content

Commit 2e15b2c

Browse files
docs: update API references to include Table of Contents for better navigation (#563)
1 parent 300b9f2 commit 2e15b2c

3 files changed

Lines changed: 25 additions & 4 deletions

File tree

agent-skills/workleap-squide/references/hooks-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ const activeRoute = useRouteMatch(location, { throwWhenThereIsNoMatch: true });
114114

115115
**Parameters:**
116116
- `locationArg`: The location to match against routes
117-
- `options.throwWhenThereIsNoMatch`: If true, throws an Error when no route matches (default: false)
117+
- `options.throwWhenThereIsNoMatch`: If true, throws an Error when no route matches (default: true)
118118

119119
**Returns:** A `Route` object if there's a match, `undefined` otherwise (or throws if `throwWhenThereIsNoMatch` is true)
120120

agent-skills/workleap-squide/references/integrations.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
# Squide Integrations Reference
22

3+
## Table of Contents
4+
- [TanStack Query](#tanstack-query)
5+
- [MSW](#msw-mock-service-worker)
6+
- [LaunchDarkly](#launchdarkly)
7+
- [Honeycomb](#honeycomb)
8+
- [i18next](#i18next)
9+
- [Storybook](#storybook)
10+
- [Logging](#logging-with-workleaplogging)
11+
312
## TanStack Query
413

514
### Setup

agent-skills/workleap-squide/references/runtime-api.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,31 @@
33
## Overview
44
The `FireflyRuntime` instance gives modules access to routing, navigation, request handlers, logging, and other cross-cutting concerns. Never instantiate directly - use `initializeFirefly()`.
55

6+
## Table of Contents
7+
- [Constructor Parameters](#constructor-parameters)
8+
- [Route Registration](#route-registration)
9+
- [Navigation Registration](#navigation-registration)
10+
- [MSW Request Handlers](#msw-request-handlers)
11+
- [Environment Variables](#environment-variables)
12+
- [Feature Flags](#feature-flags)
13+
- [Plugins](#plugins)
14+
- [Getters](#getters)
15+
- [Event Bus](#event-bus)
16+
- [Logging](#logging)
17+
618
## Constructor Parameters
719

820
```ts
921
new FireflyRuntime(options?: {
1022
mode?: "development" | "production";
11-
environmentVariables?: Record<string, string>;
1223
honeycombInstrumentationClient?: HoneycombInstrumentationClient;
13-
launchDarklyClient?: LDClient;
14-
loggers?: Logger[];
24+
loggers?: RootLogger[]; // e.g., BrowserConsoleLogger from @workleap/logging
1525
plugins?: Array<(runtime: FireflyRuntime) => Plugin>;
1626
})
1727
```
1828

29+
> For `environmentVariables`, `launchDarklyClient`, `useMsw`, and `startMsw`, use `initializeFirefly()` which creates the runtime with the appropriate plugins.
30+
1931
## Methods
2032

2133
### Route Registration

0 commit comments

Comments
 (0)