prettify

.prettierignore

@@ -132,3 +132,12 @@ test-results/
 playwright-report/
 playwright/.cache/
 
+# Generated API artifacts (regenerated via `make gen`)
+public_api.swagger.json
+proxy_api.swagger.json
+scripts/openapi-gen/openapi.json
+scripts/openapi-gen/proxy_api_openapi.json
+
+# Synced from the SDK repo via `make sync-sdk-gen-docs` (don't reformat in place)
+generated-docs/
+

DESIGN-WORKFLOW.md

@@ -17,13 +17,13 @@ Production deploys from **`main`** (see README).
 
 ## Files to edit
 
-| Change | Files |
-|--------|--------|
-| Welcome / landing layout | `welcome.mdx` |
-| Welcome / shared UI styles | `styles.css` (`.tk-*` classes) |
-| Site-wide color, nav, fonts | `docs.json` |
-| Illustrations, icons | `images/` (use `/images/...` paths) |
-| Logos / favicon | `logo/`, `favicon.svg` |
+| Change                      | Files                               |
+| --------------------------- | ----------------------------------- |
+| Welcome / landing layout    | `welcome.mdx`                       |
+| Welcome / shared UI styles  | `styles.css` (`.tk-*` classes)      |
+| Site-wide color, nav, fonts | `docs.json`                         |
+| Illustrations, icons        | `images/` (use `/images/...` paths) |
+| Logos / favicon             | `logo/`, `favicon.svg`              |
 
 Avoid unless intentional:
 

Makefile

@@ -1,12 +1,20 @@
 ROOT := $(shell git rev-parse --show-toplevel)
 JS_SDK_ROOT := $(ROOT)/../sdk
 
-.PHONY: openapi-gen gen tags mintlify-check
+.PHONY: openapi-gen gen tags mintlify-check format format-check
 
 # Convenience method to start dev server
 dev:
 	mintlify dev
 
+# Format all hand-written content with Prettier (mdx, md, css, json, ts, js, ...)
+format:
+	npm run format
+
+# Check formatting without writing changes (use in CI)
+format-check:
+	npm run format:check
+
 # Install deps for OpenAPI
 install:
 	cd scripts/openapi-gen && npm install

README.md

@@ -25,6 +25,21 @@ mintlify dev
 
 This will start a local development server where you can preview your changes in real-time.
 
+### Formatting
+
+This repo uses [Prettier](https://prettier.io) to format all hand-written content (`.mdx`, `.md`, `.css`, `.json`, `.ts`, `.js`, ...). Generated artifacts (swagger files, `generated-docs/`) are excluded via `.prettierignore`.
+
+```sh
+# Install dev dependencies (one time)
+npm install
+
+# Format everything in place
+npm run format   # or: make format
+
+# Check formatting without writing (useful in CI)
+npm run format:check   # or: make format-check
+```
+
 If you encounter any issues with the development server:
 
 - Run `mintlify install` to reinstall dependencies
@@ -69,10 +84,10 @@ The docs in this repository utilize shared MDX snippets to ensure consistency an
 
 **Important:** Always update the shared MDX file rather than modifying individual duplicate pages. This guarantees that any change propagates throughout all references.
 
-| Duplicate Page Path                                           | Shared MDX File                       |
-| ------------------------------------------------------------- | ------------------------------------- |
-| `concepts/policies/overview.mdx`                              | `/snippets/shared/policy-engine.mdx`  |
-| `products/embedded-wallets/features/policy-engine.mdx`        | `/snippets/shared/policy-engine.mdx`  |
+| Duplicate Page Path                                    | Shared MDX File                       |
+| ------------------------------------------------------ | ------------------------------------- |
+| `concepts/policies/overview.mdx`                       | `/snippets/shared/policy-engine.mdx`  |
+| `products/embedded-wallets/features/policy-engine.mdx` | `/snippets/shared/policy-engine.mdx`  |
 | `products/company-wallets/features/export-wallets.mdx` | `/snippets/shared/export-wallets.mdx` |
 | `products/company-wallets/features/import-wallets.mdx` | `/snippets/shared/import-wallets.mdx` |
 

api-reference/activities/approve-activity.mdx

@@ -17,16 +17,19 @@ import { EndpointPath } from "/snippets/api/endpoint.mdx";
 <ParamField body="type" type="enum<string>" required={true}>
 
 Enum options: `ACTIVITY_TYPE_APPROVE_ACTIVITY`
+
 </ParamField>
 
 <ParamField body="timestampMs" type="string" required={true}>
 
 Timestamp (in milliseconds) of the request, used to verify liveness of user requests.
+
 </ParamField>
 
 <ParamField body="organizationId" type="string" required={true}>
 
 Unique identifier for a given Organization.
+
 </ParamField>
 
 <ParamField body="parameters" type="object" required={true} path="parameters">
@@ -40,11 +43,11 @@ Unique identifier for a given Organization.
 <ParamField body="generateAppProofs" type="boolean" required={false}>
 
 Enable to have your activity generate and return App Proofs, enabling verifiability.
-</ParamField>
 
+</ParamField>
 
-<H3Bordered text="Response" />
-A successful response returns the following fields:
+<H3Bordered text="Response" />A successful response returns the following
+fields:
 
 <ResponseField name="activity" type="object" required={true}>
   The activity object containing type, intent, and result
@@ -76,26 +79,58 @@ An artifact verifying a User's action.
 
       </Expandable>
     </NestedParam>
-<NestedParam parentKey="activity" childKey="result" type="object" required={true}>
-The result of the activity
+
+<NestedParam
+  parentKey="activity"
+  childKey="result"
+  type="object"
+  required={true}
+>
+  The result of the activity
 </NestedParam>
 <NestedParam parentKey="activity" childKey="votes" type="array" required={true}>
-A list of objects representing a particular User's approval or rejection of a Consensus request, including all relevant metadata.
+  A list of objects representing a particular User's approval or rejection of a
+  Consensus request, including all relevant metadata.
 </NestedParam>
-<NestedParam parentKey="activity" childKey="fingerprint" type="string" required={true}>
-An artifact verifying a User's action.
+<NestedParam
+  parentKey="activity"
+  childKey="fingerprint"
+  type="string"
+  required={true}
+>
+  An artifact verifying a User's action.
 </NestedParam>
-<NestedParam parentKey="activity" childKey="canApprove" type="boolean" required={true}>
-Whether the activity can be approved.
+<NestedParam
+  parentKey="activity"
+  childKey="canApprove"
+  type="boolean"
+  required={true}
+>
+  Whether the activity can be approved.
 </NestedParam>
-<NestedParam parentKey="activity" childKey="canReject" type="boolean" required={true}>
-Whether the activity can be rejected.
+<NestedParam
+  parentKey="activity"
+  childKey="canReject"
+  type="boolean"
+  required={true}
+>
+  Whether the activity can be rejected.
 </NestedParam>
-<NestedParam parentKey="activity" childKey="createdAt" type="string" required={true}>
-The creation timestamp.
+<NestedParam
+  parentKey="activity"
+  childKey="createdAt"
+  type="string"
+  required={true}
+>
+  The creation timestamp.
 </NestedParam>
-<NestedParam parentKey="activity" childKey="updatedAt" type="string" required={true}>
-The last update timestamp.
+<NestedParam
+  parentKey="activity"
+  childKey="updatedAt"
+  type="string"
+  required={true}
+>
+  The last update timestamp.
 </NestedParam>
 
   </Expandable>

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

@@ -17,16 +17,19 @@ import { EndpointPath } from "/snippets/api/endpoint.mdx";
 <ParamField body="type" type="enum<string>" required={true}>
 
 Enum options: `ACTIVITY_TYPE_ETH_SEND_TRANSACTION`
+
 </ParamField>
 
 <ParamField body="timestampMs" type="string" required={true}>
 
 Timestamp (in milliseconds) of the request, used to verify liveness of user requests.
+
 </ParamField>
 
 <ParamField body="organizationId" type="string" required={true}>
 
 Unique identifier for a given Organization.
+
 </ParamField>
 
 <ParamField body="parameters" type="object" required={true} path="parameters">
@@ -84,11 +87,11 @@ Unique identifier for a given Organization.
 <ParamField body="generateAppProofs" type="boolean" required={false}>
 
 Enable to have your activity generate and return App Proofs, enabling verifiability.
-</ParamField>
 
+</ParamField>
 
-<H3Bordered text="Response" />
-A successful response returns the following fields:
+<H3Bordered text="Response" />A successful response returns the following
+fields:
 
 <ResponseField name="activity" type="object" required={true}>
   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
 
       </Expandable>
     </NestedParam>
+
 <NestedParam parentKey="activity" childKey="result" type="object" required={true}>
       The result of the activity
       <Expandable title="result details">
@@ -171,23 +175,50 @@ The send_transaction_status ID associated with the transaction submission
 
       </Expandable>
     </NestedParam>
+
 <NestedParam parentKey="activity" childKey="votes" type="array" required={true}>
-A list of objects representing a particular User's approval or rejection of a Consensus request, including all relevant metadata.
+  A list of objects representing a particular User's approval or rejection of a
+  Consensus request, including all relevant metadata.
 </NestedParam>
-<NestedParam parentKey="activity" childKey="fingerprint" type="string" required={true}>
-An artifact verifying a User's action.
+<NestedParam
+  parentKey="activity"
+  childKey="fingerprint"
+  type="string"
+  required={true}
+>
+  An artifact verifying a User's action.
 </NestedParam>
-<NestedParam parentKey="activity" childKey="canApprove" type="boolean" required={true}>
-Whether the activity can be approved.
+<NestedParam
+  parentKey="activity"
+  childKey="canApprove"
+  type="boolean"
+  required={true}
+>
+  Whether the activity can be approved.
 </NestedParam>
-<NestedParam parentKey="activity" childKey="canReject" type="boolean" required={true}>
-Whether the activity can be rejected.
+<NestedParam
+  parentKey="activity"
+  childKey="canReject"
+  type="boolean"
+  required={true}
+>
+  Whether the activity can be rejected.
 </NestedParam>
-<NestedParam parentKey="activity" childKey="createdAt" type="string" required={true}>
-The creation timestamp.
+<NestedParam
+  parentKey="activity"
+  childKey="createdAt"
+  type="string"
+  required={true}
+>
+  The creation timestamp.
 </NestedParam>
-<NestedParam parentKey="activity" childKey="updatedAt" type="string" required={true}>
-The last update timestamp.
+<NestedParam
+  parentKey="activity"
+  childKey="updatedAt"
+  type="string"
+  required={true}
+>
+  The last update timestamp.
 </NestedParam>
 
   </Expandable>