Skip to content

Commit fc190fc

Browse files
andrewkminandrewkmin
committed
prettify
1 parent 1f40580 commit fc190fc

367 files changed

Lines changed: 14493 additions & 6742 deletions

File tree

Some content is hidden

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

‎DESIGN-WORKFLOW.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ Production deploys from **`main`** (see README).
1717

1818
## Files to edit
1919

20-
| Change | Files |
21-
|--------|--------|
22-
| Welcome / landing layout | `welcome.mdx` |
23-
| Welcome / shared UI styles | `styles.css` (`.tk-*` classes) |
24-
| Site-wide color, nav, fonts | `docs.json` |
25-
| Illustrations, icons | `images/` (use `/images/...` paths) |
26-
| Logos / favicon | `logo/`, `favicon.svg` |
20+
| Change | Files |
21+
| --------------------------- | ----------------------------------- |
22+
| Welcome / landing layout | `welcome.mdx` |
23+
| Welcome / shared UI styles | `styles.css` (`.tk-*` classes) |
24+
| Site-wide color, nav, fonts | `docs.json` |
25+
| Illustrations, icons | `images/` (use `/images/...` paths) |
26+
| Logos / favicon | `logo/`, `favicon.svg` |
2727

2828
Avoid unless intentional:
2929

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,10 @@ The docs in this repository utilize shared MDX snippets to ensure consistency an
8484

8585
**Important:** Always update the shared MDX file rather than modifying individual duplicate pages. This guarantees that any change propagates throughout all references.
8686

87-
| Duplicate Page Path | Shared MDX File |
88-
| ------------------------------------------------------------- | ------------------------------------- |
89-
| `concepts/policies/overview.mdx` | `/snippets/shared/policy-engine.mdx` |
90-
| `products/embedded-wallets/features/policy-engine.mdx` | `/snippets/shared/policy-engine.mdx` |
87+
| Duplicate Page Path | Shared MDX File |
88+
| ------------------------------------------------------ | ------------------------------------- |
89+
| `concepts/policies/overview.mdx` | `/snippets/shared/policy-engine.mdx` |
90+
| `products/embedded-wallets/features/policy-engine.mdx` | `/snippets/shared/policy-engine.mdx` |
9191
| `products/company-wallets/features/export-wallets.mdx` | `/snippets/shared/export-wallets.mdx` |
9292
| `products/company-wallets/features/import-wallets.mdx` | `/snippets/shared/import-wallets.mdx` |
9393

‎api-reference/activities/approve-activity.mdx‎

Lines changed: 51 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,19 @@ import { EndpointPath } from "/snippets/api/endpoint.mdx";
1717
<ParamField body="type" type="enum<string>" required={true}>
1818

1919
Enum options: `ACTIVITY_TYPE_APPROVE_ACTIVITY`
20+
2021
</ParamField>
2122

2223
<ParamField body="timestampMs" type="string" required={true}>
2324

2425
Timestamp (in milliseconds) of the request, used to verify liveness of user requests.
26+
2527
</ParamField>
2628

2729
<ParamField body="organizationId" type="string" required={true}>
2830

2931
Unique identifier for a given Organization.
32+
3033
</ParamField>
3134

3235
<ParamField body="parameters" type="object" required={true} path="parameters">
@@ -40,11 +43,11 @@ Unique identifier for a given Organization.
4043
<ParamField body="generateAppProofs" type="boolean" required={false}>
4144

4245
Enable to have your activity generate and return App Proofs, enabling verifiability.
43-
</ParamField>
4446

47+
</ParamField>
4548

46-
<H3Bordered text="Response" />
47-
A successful response returns the following fields:
49+
<H3Bordered text="Response" />A successful response returns the following
50+
fields:
4851

4952
<ResponseField name="activity" type="object" required={true}>
5053
The activity object containing type, intent, and result
@@ -76,26 +79,58 @@ An artifact verifying a User's action.
7679

7780
</Expandable>
7881
</NestedParam>
79-
<NestedParam parentKey="activity" childKey="result" type="object" required={true}>
80-
The result of the activity
82+
83+
<NestedParam
84+
parentKey="activity"
85+
childKey="result"
86+
type="object"
87+
required={true}
88+
>
89+
The result of the activity
8190
</NestedParam>
8291
<NestedParam parentKey="activity" childKey="votes" type="array" required={true}>
83-
A list of objects representing a particular User's approval or rejection of a Consensus request, including all relevant metadata.
92+
A list of objects representing a particular User's approval or rejection of a
93+
Consensus request, including all relevant metadata.
8494
</NestedParam>
85-
<NestedParam parentKey="activity" childKey="fingerprint" type="string" required={true}>
86-
An artifact verifying a User's action.
95+
<NestedParam
96+
parentKey="activity"
97+
childKey="fingerprint"
98+
type="string"
99+
required={true}
100+
>
101+
An artifact verifying a User's action.
87102
</NestedParam>
88-
<NestedParam parentKey="activity" childKey="canApprove" type="boolean" required={true}>
89-
Whether the activity can be approved.
103+
<NestedParam
104+
parentKey="activity"
105+
childKey="canApprove"
106+
type="boolean"
107+
required={true}
108+
>
109+
Whether the activity can be approved.
90110
</NestedParam>
91-
<NestedParam parentKey="activity" childKey="canReject" type="boolean" required={true}>
92-
Whether the activity can be rejected.
111+
<NestedParam
112+
parentKey="activity"
113+
childKey="canReject"
114+
type="boolean"
115+
required={true}
116+
>
117+
Whether the activity can be rejected.
93118
</NestedParam>
94-
<NestedParam parentKey="activity" childKey="createdAt" type="string" required={true}>
95-
The creation timestamp.
119+
<NestedParam
120+
parentKey="activity"
121+
childKey="createdAt"
122+
type="string"
123+
required={true}
124+
>
125+
The creation timestamp.
96126
</NestedParam>
97-
<NestedParam parentKey="activity" childKey="updatedAt" type="string" required={true}>
98-
The last update timestamp.
127+
<NestedParam
128+
parentKey="activity"
129+
childKey="updatedAt"
130+
type="string"
131+
required={true}
132+
>
133+
The last update timestamp.
99134
</NestedParam>
100135

101136
</Expandable>

‎api-reference/activities/broadcast-evm-transaction.mdx‎

Lines changed: 45 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,19 @@ import { EndpointPath } from "/snippets/api/endpoint.mdx";
1717
<ParamField body="type" type="enum<string>" required={true}>
1818

1919
Enum options: `ACTIVITY_TYPE_ETH_SEND_TRANSACTION`
20+
2021
</ParamField>
2122

2223
<ParamField body="timestampMs" type="string" required={true}>
2324

2425
Timestamp (in milliseconds) of the request, used to verify liveness of user requests.
26+
2527
</ParamField>
2628

2729
<ParamField body="organizationId" type="string" required={true}>
2830

2931
Unique identifier for a given Organization.
32+
3033
</ParamField>
3134

3235
<ParamField body="parameters" type="object" required={true} path="parameters">
@@ -84,11 +87,11 @@ Unique identifier for a given Organization.
8487
<ParamField body="generateAppProofs" type="boolean" required={false}>
8588

8689
Enable to have your activity generate and return App Proofs, enabling verifiability.
87-
</ParamField>
8890

91+
</ParamField>
8992

90-
<H3Bordered text="Response" />
91-
A successful response returns the following fields:
93+
<H3Bordered text="Response" />A successful response returns the following
94+
fields:
9295

9396
<ResponseField name="activity" type="object" required={true}>
9497
The activity object containing type, intent, and result
@@ -156,6 +159,7 @@ The gas station delegate contract nonce. Only used when sponsor=true. Include th
156159

157160
</Expandable>
158161
</NestedParam>
162+
159163
<NestedParam parentKey="activity" childKey="result" type="object" required={true}>
160164
The result of the activity
161165
<Expandable title="result details">
@@ -171,23 +175,50 @@ The send_transaction_status ID associated with the transaction submission
171175

172176
</Expandable>
173177
</NestedParam>
178+
174179
<NestedParam parentKey="activity" childKey="votes" type="array" required={true}>
175-
A list of objects representing a particular User's approval or rejection of a Consensus request, including all relevant metadata.
180+
A list of objects representing a particular User's approval or rejection of a
181+
Consensus request, including all relevant metadata.
176182
</NestedParam>
177-
<NestedParam parentKey="activity" childKey="fingerprint" type="string" required={true}>
178-
An artifact verifying a User's action.
183+
<NestedParam
184+
parentKey="activity"
185+
childKey="fingerprint"
186+
type="string"
187+
required={true}
188+
>
189+
An artifact verifying a User's action.
179190
</NestedParam>
180-
<NestedParam parentKey="activity" childKey="canApprove" type="boolean" required={true}>
181-
Whether the activity can be approved.
191+
<NestedParam
192+
parentKey="activity"
193+
childKey="canApprove"
194+
type="boolean"
195+
required={true}
196+
>
197+
Whether the activity can be approved.
182198
</NestedParam>
183-
<NestedParam parentKey="activity" childKey="canReject" type="boolean" required={true}>
184-
Whether the activity can be rejected.
199+
<NestedParam
200+
parentKey="activity"
201+
childKey="canReject"
202+
type="boolean"
203+
required={true}
204+
>
205+
Whether the activity can be rejected.
185206
</NestedParam>
186-
<NestedParam parentKey="activity" childKey="createdAt" type="string" required={true}>
187-
The creation timestamp.
207+
<NestedParam
208+
parentKey="activity"
209+
childKey="createdAt"
210+
type="string"
211+
required={true}
212+
>
213+
The creation timestamp.
188214
</NestedParam>
189-
<NestedParam parentKey="activity" childKey="updatedAt" type="string" required={true}>
190-
The last update timestamp.
215+
<NestedParam
216+
parentKey="activity"
217+
childKey="updatedAt"
218+
type="string"
219+
required={true}
220+
>
221+
The last update timestamp.
191222
</NestedParam>
192223

193224
</Expandable>

‎api-reference/activities/broadcast-svm-transaction.mdx‎

Lines changed: 45 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,19 @@ import { EndpointPath } from "/snippets/api/endpoint.mdx";
1717
<ParamField body="type" type="enum<string>" required={true}>
1818

1919
Enum options: `ACTIVITY_TYPE_SOL_SEND_TRANSACTION`
20+
2021
</ParamField>
2122

2223
<ParamField body="timestampMs" type="string" required={true}>
2324

2425
Timestamp (in milliseconds) of the request, used to verify liveness of user requests.
26+
2527
</ParamField>
2628

2729
<ParamField body="organizationId" type="string" required={true}>
2830

2931
Unique identifier for a given Organization.
32+
3033
</ParamField>
3134

3235
<ParamField body="parameters" type="object" required={true} path="parameters">
@@ -56,11 +59,11 @@ Unique identifier for a given Organization.
5659
<ParamField body="generateAppProofs" type="boolean" required={false}>
5760

5861
Enable to have your activity generate and return App Proofs, enabling verifiability.
59-
</ParamField>
6062

63+
</ParamField>
6164

62-
<H3Bordered text="Response" />
63-
A successful response returns the following fields:
65+
<H3Bordered text="Response" />A successful response returns the following
66+
fields:
6467

6568
<ResponseField name="activity" type="object" required={true}>
6669
The activity object containing type, intent, and result
@@ -107,6 +110,7 @@ user-provided blockhash for replay protection / deadline control. If omitted and
107110

108111
</Expandable>
109112
</NestedParam>
113+
110114
<NestedParam parentKey="activity" childKey="result" type="object" required={true}>
111115
The result of the activity
112116
<Expandable title="result details">
@@ -122,23 +126,50 @@ The send_transaction_status ID associated with the transaction submission
122126

123127
</Expandable>
124128
</NestedParam>
129+
125130
<NestedParam parentKey="activity" childKey="votes" type="array" required={true}>
126-
A list of objects representing a particular User's approval or rejection of a Consensus request, including all relevant metadata.
131+
A list of objects representing a particular User's approval or rejection of a
132+
Consensus request, including all relevant metadata.
127133
</NestedParam>
128-
<NestedParam parentKey="activity" childKey="fingerprint" type="string" required={true}>
129-
An artifact verifying a User's action.
134+
<NestedParam
135+
parentKey="activity"
136+
childKey="fingerprint"
137+
type="string"
138+
required={true}
139+
>
140+
An artifact verifying a User's action.
130141
</NestedParam>
131-
<NestedParam parentKey="activity" childKey="canApprove" type="boolean" required={true}>
132-
Whether the activity can be approved.
142+
<NestedParam
143+
parentKey="activity"
144+
childKey="canApprove"
145+
type="boolean"
146+
required={true}
147+
>
148+
Whether the activity can be approved.
133149
</NestedParam>
134-
<NestedParam parentKey="activity" childKey="canReject" type="boolean" required={true}>
135-
Whether the activity can be rejected.
150+
<NestedParam
151+
parentKey="activity"
152+
childKey="canReject"
153+
type="boolean"
154+
required={true}
155+
>
156+
Whether the activity can be rejected.
136157
</NestedParam>
137-
<NestedParam parentKey="activity" childKey="createdAt" type="string" required={true}>
138-
The creation timestamp.
158+
<NestedParam
159+
parentKey="activity"
160+
childKey="createdAt"
161+
type="string"
162+
required={true}
163+
>
164+
The creation timestamp.
139165
</NestedParam>
140-
<NestedParam parentKey="activity" childKey="updatedAt" type="string" required={true}>
141-
The last update timestamp.
166+
<NestedParam
167+
parentKey="activity"
168+
childKey="updatedAt"
169+
type="string"
170+
required={true}
171+
>
172+
The last update timestamp.
142173
</NestedParam>
143174

144175
</Expandable>

0 commit comments

Comments
 (0)