Skip to content

Commit 6fba380

Browse files
dslovinskyclaude
andauthored
fix: use markdown tables in reference docs for responsive rendering (#2343)
* chore: regenerate reference docs for v4.84.0 Regenerate TypeDoc output to reflect current aa-sdk exports. Picks up new chain definitions (hyperliquid, monad, mythos, etc.) and removes docs for deleted APIs (session keys, legacy account factories, plugin system). Co-Authored-By: Claude <noreply@anthropic.com> * fix: use markdown tables in reference docs for responsive rendering Change typedoc table format from htmlTable to table so generated reference docs use markdown pipe syntax instead of raw HTML <table> elements. This allows the docs-site MDX Table component to wrap tables in a scrollable container for narrow screens. Co-Authored-By: Claude <noreply@anthropic.com> --------- Co-authored-by: dslovinsky <dslovinsky@users.noreply.github.com> Co-authored-by: Claude <noreply@anthropic.com>
1 parent d80fd19 commit 6fba380

File tree

1,176 files changed

+11253
-124974
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,176 files changed

+11253
-124974
lines changed

docs-site

Submodule docs-site updated 30 files

docs/docs.yml

Lines changed: 26 additions & 568 deletions
Large diffs are not rendered by default.

docs/pages/reference/aa-sdk/core/src/classes/AccountNotFoundError.mdx

Lines changed: 25 additions & 286 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ layout: reference
77

88
{/* This file is auto-generated by TypeDoc. Do not edit manually. */}
99

10-
Defined in: [aa-sdk/core/src/errors/account.ts:8](https://github.com/alchemyplatform/aa-sdk/blob/27e36329c103b4660886c9508b86d0a2c5c6c47e/aa-sdk/core/src/errors/account.ts#L8)
10+
Defined in: [aa-sdk/core/src/errors/account.ts:8](https://github.com/alchemyplatform/aa-sdk/blob/3e18d9576e65cdac5cac073ca850cbc18ad72ff1/aa-sdk/core/src/errors/account.ts#L8)
1111

1212
This error is thrown when an account could not be found to execute a specific action. It extends the `BaseError` class.
1313

@@ -23,7 +23,7 @@ This error is thrown when an account could not be found to execute a specific ac
2323
new AccountNotFoundError(): AccountNotFoundError;
2424
```
2525

26-
Defined in: [aa-sdk/core/src/errors/account.ts:15](https://github.com/alchemyplatform/aa-sdk/blob/27e36329c103b4660886c9508b86d0a2c5c6c47e/aa-sdk/core/src/errors/account.ts#L15)
26+
Defined in: [aa-sdk/core/src/errors/account.ts:15](https://github.com/alchemyplatform/aa-sdk/blob/3e18d9576e65cdac5cac073ca850cbc18ad72ff1/aa-sdk/core/src/errors/account.ts#L15)
2727

2828
Constructor for initializing an error message indicating that an account could not be found to execute the specified action.
2929

@@ -37,207 +37,18 @@ Constructor for initializing an error message indicating that an account could n
3737

3838
## Properties
3939

40-
<table>
41-
<thead>
42-
<tr>
43-
<th align="left">Property</th>
44-
<th align="left">Type</th>
45-
<th align="left">Default value</th>
46-
<th align="left">Description</th>
47-
</tr>
48-
</thead>
49-
50-
<tbody>
51-
<tr>
52-
<td>
53-
<a id="cause" /> `cause?`
54-
</td>
55-
56-
<td>
57-
`unknown`
58-
</td>
59-
60-
<td>
61-
`undefined`
62-
</td>
63-
64-
<td>
65-
66-
</td>
67-
</tr>
68-
69-
<tr>
70-
<td>
71-
<a id="details" /> `details`
72-
</td>
73-
74-
<td>
75-
`string`
76-
</td>
77-
78-
<td>
79-
`undefined`
80-
</td>
81-
82-
<td>
83-
84-
</td>
85-
</tr>
86-
87-
<tr>
88-
<td>
89-
<a id="docspath" /> `docsPath?`
90-
</td>
91-
92-
<td>
93-
`string`
94-
</td>
95-
96-
<td>
97-
`undefined`
98-
</td>
99-
100-
<td>
101-
102-
</td>
103-
</tr>
104-
105-
<tr>
106-
<td>
107-
<a id="message" /> `message`
108-
</td>
109-
110-
<td>
111-
`string`
112-
</td>
113-
114-
<td>
115-
`undefined`
116-
</td>
117-
118-
<td>
119-
120-
</td>
121-
</tr>
122-
123-
<tr>
124-
<td>
125-
<a id="metamessages" /> `metaMessages?`
126-
</td>
127-
128-
<td>
129-
`string`\[]
130-
</td>
131-
132-
<td>
133-
`undefined`
134-
</td>
135-
136-
<td>
137-
138-
</td>
139-
</tr>
140-
141-
<tr>
142-
<td>
143-
<a id="name" /> `name`
144-
</td>
145-
146-
<td>
147-
`string`
148-
</td>
149-
150-
<td>
151-
`"AccountNotFoundError"`
152-
</td>
153-
154-
<td>
155-
156-
</td>
157-
</tr>
158-
159-
<tr>
160-
<td>
161-
<a id="shortmessage" /> `shortMessage`
162-
</td>
163-
164-
<td>
165-
`string`
166-
</td>
167-
168-
<td>
169-
`undefined`
170-
</td>
171-
172-
<td>
173-
174-
</td>
175-
</tr>
176-
177-
<tr>
178-
<td>
179-
<a id="stack" /> `stack?`
180-
</td>
181-
182-
<td>
183-
`string`
184-
</td>
185-
186-
<td>
187-
`undefined`
188-
</td>
189-
190-
<td>
191-
192-
</td>
193-
</tr>
194-
195-
<tr>
196-
<td>
197-
<a id="version" /> `version`
198-
</td>
199-
200-
<td>
201-
`string`
202-
</td>
203-
204-
<td>
205-
`VERSION`
206-
</td>
207-
208-
<td>
209-
210-
</td>
211-
</tr>
212-
213-
<tr>
214-
<td>
215-
<a id="stacktracelimit" /> `stackTraceLimit`
216-
</td>
217-
218-
<td>
219-
`number`
220-
</td>
221-
222-
<td>
223-
`undefined`
224-
</td>
225-
226-
<td>
227-
The `Error.stackTraceLimit` property specifies the number of stack frames
228-
collected by a stack trace (whether generated by `new Error().stack` or
229-
`Error.captureStackTrace(obj)`).
230-
231-
The default value is `10` but may be set to any valid JavaScript number. Changes
232-
will affect any stack trace captured *after* the value has been changed.
233-
234-
If set to a non-number value, or set to a negative number, stack traces will
235-
not capture any frames.
236-
</td>
237-
</tr>
238-
239-
</tbody>
240-
</table>
40+
| Property | Type | Default value | Description |
41+
| :------------------------------------------- | :---------- | :----------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
42+
| <a id="cause" /> `cause?` | `unknown` | `undefined` | - |
43+
| <a id="details" /> `details` | `string` | `undefined` | - |
44+
| <a id="docspath" /> `docsPath?` | `string` | `undefined` | - |
45+
| <a id="message" /> `message` | `string` | `undefined` | - |
46+
| <a id="metamessages" /> `metaMessages?` | `string`\[] | `undefined` | - |
47+
| <a id="name" /> `name` | `string` | `"AccountNotFoundError"` | - |
48+
| <a id="shortmessage" /> `shortMessage` | `string` | `undefined` | - |
49+
| <a id="stack" /> `stack?` | `string` | `undefined` | - |
50+
| <a id="version" /> `version` | `string` | `VERSION` | - |
51+
| <a id="stacktracelimit" /> `stackTraceLimit` | `number` | `undefined` | The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured _after_ the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames. |
24152

24253
## Methods
24354

@@ -269,27 +80,9 @@ Defined in: node_modules/viem/\_types/errors/base.d.ts:27
26980

27081
##### Parameters
27182

272-
<table>
273-
<thead>
274-
<tr>
275-
<th align="left">Parameter</th>
276-
<th align="left">Type</th>
277-
</tr>
278-
</thead>
279-
280-
<tbody>
281-
<tr>
282-
<td>
283-
`fn`
284-
</td>
285-
286-
<td>
287-
(`err`) => `boolean`
288-
</td>
289-
</tr>
290-
291-
</tbody>
292-
</table>
83+
| Parameter | Type |
84+
| :-------- | :------------------- |
85+
| `fn` | (`err`) => `boolean` |
29386

29487
##### Returns
29588

@@ -355,37 +148,10 @@ a();
355148
356149
#### Parameters
357150
358-
<table>
359-
<thead>
360-
<tr>
361-
<th align="left">Parameter</th>
362-
<th align="left">Type</th>
363-
</tr>
364-
</thead>
365-
366-
<tbody>
367-
<tr>
368-
<td>
369-
`targetObject`
370-
</td>
371-
372-
<td>
373-
`object`
374-
</td>
375-
</tr>
376-
377-
<tr>
378-
<td>
379-
`constructorOpt?`
380-
</td>
381-
382-
<td>
383-
`Function`
384-
</td>
385-
</tr>
386-
387-
</tbody>
388-
</table>
151+
| Parameter | Type |
152+
| :---------------- | :--------- |
153+
| `targetObject` | `object` |
154+
| `constructorOpt?` | `Function` |
389155
390156
#### Returns
391157
@@ -407,37 +173,10 @@ Defined in: node_modules/@types/node/globals.d.ts:149
407173
408174
#### Parameters
409175
410-
<table>
411-
<thead>
412-
<tr>
413-
<th align="left">Parameter</th>
414-
<th align="left">Type</th>
415-
</tr>
416-
</thead>
417-
418-
<tbody>
419-
<tr>
420-
<td>
421-
`err`
422-
</td>
423-
424-
<td>
425-
`Error`
426-
</td>
427-
</tr>
428-
429-
<tr>
430-
<td>
431-
`stackTraces`
432-
</td>
433-
434-
<td>
435-
`CallSite`\[]
436-
</td>
437-
</tr>
438-
439-
</tbody>
440-
</table>
176+
| Parameter | Type |
177+
| :------------ | :------------ |
178+
| `err` | `Error` |
179+
| `stackTraces` | `CallSite`\[] |
441180
442181
#### Returns
443182

0 commit comments

Comments
 (0)