> ## Documentation Index
> Fetch the complete documentation index at: https://base-a060aa97-docs-kb-gaps-devrel-822-kb-docs-process.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Mintlify reference

## Mintlify component reference

Full mintlify reference docs can be found at [https://www.mintlify.com/docs/llms.txt](https://www.mintlify.com/docs/llms.txt)

### docs.json

* Refer to the [docs.json schema](https://mintlify.com/docs.json) when building the docs.json file and site navigation
* If any documents have been removed from the /docs folder, ensure that a redirect is implemented

### Callout components

Use these sparingly, only when it's important to highlight information which might otherwise be missed by someone scanning the page.

#### Note - Additional helpful information

<Note>
  Supplementary information that supports the main content without interrupting flow
</Note>

#### Tip - Best practices and pro tips

<Tip>
  Expert advice, shortcuts, or best practices that enhance user success
</Tip>

#### Warning - Important cautions

<Warning>
  Critical information about potential issues, breaking changes, or destructive actions
</Warning>

#### Info - Neutral contextual information

<Info>
  Background information, context, or neutral announcements
</Info>

#### Check - Success confirmations

<Check>
  Positive confirmations, successful completions, or achievement indicators
</Check>

### Code components

#### Code group with multiple languages

Example of a code group:

<CodeGroup>
  ```javascript Node.js theme={null}
  const response = await fetch('/api/endpoint', {
    headers: { Authorization: `Bearer ${apiKey}` }
  });
  ```

  ```python Python theme={null}
  import requests
  response = requests.get('/api/endpoint', 
    headers={'Authorization': f'Bearer {api_key}'})
  ```

  ```curl cURL theme={null}
  curl -X GET '/api/endpoint' \
    -H 'Authorization: Bearer YOUR_API_KEY'
  ```
</CodeGroup>

### Structural components

#### Steps for procedures

Example of step-by-step instructions:

<Steps>
  <Step title="Install dependencies">
    Run `npm install` to install required packages.
  </Step>

  <Step title="Configure environment">
    Create a `.env` file with your API credentials.
  </Step>
</Steps>

#### Tabs for alternative content

Example of tabbed content:

<Tabs>
  <Tab title="macOS">
    ```bash theme={null}
    brew install node
    npm install -g package-name
    ```
  </Tab>
</Tabs>

#### Accordions for collapsible content

Example of accordion groups:

<AccordionGroup>
  <Accordion title="Troubleshooting connection issues">
    * **Firewall blocking**: Ensure ports 80 and 443 are open
    * **Proxy configuration**: Set HTTP\_PROXY environment variable
    * **DNS resolution**: Try using 8.8.8.8 as DNS server
  </Accordion>

  <Accordion title="Advanced configuration">
    ```javascript theme={null}
    const config = {
      performance: { cache: true, timeout: 30000 },
      security: { encryption: 'AES-256' }
    };
    ```
  </Accordion>
</AccordionGroup>

### Cards and columns for emphasizing information

Example of cards and card groups:

<Card title="Getting started guide" icon="rocket" href="/get-started/base">
  Complete walkthrough from installation to your first API call in under 10 minutes.
</Card>

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="https://docs.cdp.coinbase.com/coinbase-wallet/guides/authenticate-users">
    Learn how to authenticate requests using API keys or JWT tokens.
  </Card>

  <Card title="Network fees" icon="clock" href="/specifications/transactions/network-fees">
    Understand network fees and best practices for estimating transaction costs.
  </Card>
</CardGroup>

### API documentation components

#### Parameter fields

Example of parameter documentation:

<ParamField path="user_id" type="string" required>
  Unique identifier for the user. Must be a valid UUID v4 format.
</ParamField>

<ParamField body="email" type="string" required>
  User's email address. Must be valid and unique within the system.
</ParamField>

<ParamField query="limit" type="integer" default="10">
  Maximum number of results to return. Range: 1-100.
</ParamField>

<ParamField header="Authorization" type="string" required>
  Bearer token for API authentication. Format: `Bearer YOUR_API_KEY`
</ParamField>

#### Response fields

Example of response field documentation:

<ResponseField name="user_id" type="string" required>
  Unique identifier assigned to the newly created user.
</ResponseField>

<ResponseField name="created_at" type="timestamp">
  ISO 8601 formatted timestamp of when the user was created.
</ResponseField>

<ResponseField name="permissions" type="array">
  List of permission strings assigned to this user.
</ResponseField>

#### Expandable nested fields

Example of nested field documentation:

<ResponseField name="user" type="object">
  Complete user object with all associated data.

  <Expandable title="User properties">
    <ResponseField name="profile" type="object">
      User profile information including personal details.

      <Expandable title="Profile details">
        <ResponseField name="first_name" type="string">
          User's first name as entered during registration.
        </ResponseField>

        <ResponseField name="avatar_url" type="string | null">
          URL to user's profile picture. Returns null if no avatar is set.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

### Media and advanced components

#### Frames for images

Wrap all images in frames:

<Frame>
  <img src="https://mintcdn.com/base-a060aa97-docs-kb-gaps-devrel-822-kb-docs-process/zH7YB6Vc1HOrQSLZ/images/build-with-zora/dashboard.png?fit=max&auto=format&n=zH7YB6Vc1HOrQSLZ&q=85&s=6d24db8ad0680a69252bd13b2a0fd38c" alt="Example dashboard" width="1024" height="789" data-path="images/build-with-zora/dashboard.png" />
</Frame>

<Frame caption="The dashboard provides real-time insights">
  <img src="https://mintcdn.com/base-a060aa97-docs-kb-gaps-devrel-822-kb-docs-process/zH7YB6Vc1HOrQSLZ/images/account-abstraction/privy-dashboard-page.png?fit=max&auto=format&n=zH7YB6Vc1HOrQSLZ&q=85&s=bc2221209b4e422fb36335282a81c135" alt="Example dashboard page" width="933" height="656" data-path="images/account-abstraction/privy-dashboard-page.png" />
</Frame>

#### Videos

Use the HTML video element for self-hosted video content:

<video controls className="w-full aspect-video rounded-xl" src="https://mintlify.s3.us-west-1.amazonaws.com/base-a060aa97-docs-kb-gaps-devrel-822-kb-docs-process/link-to-your-video.com" />

Embed YouTube videos using iframe elements:

<iframe className="w-full aspect-video rounded-xl" src="https://www.youtube.com/embed/4KzFe50RQkQ" title="YouTube video player" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowFullScreen />

#### Tooltips

Example of tooltip usage:

<Tooltip tip="Application Programming Interface - protocols for building software">
  API
</Tooltip>

#### Updates

Use updates for changelogs:

<Update label="Version 2.1.0" description="Released March 15, 2024">
  ## New features

  * Added bulk user import functionality
  * Improved error messages with actionable suggestions

  ## Bug fixes

  * Fixed pagination issue with large datasets
  * Resolved authentication timeout problems
</Update>
