mint.json

{
  "$schema": "https://mintlify.com/schema.json",
  "name": "Shuttle Docs",
  "analytics": {
    "posthog": {
      "apiKey": "phc_cQMQqF5QmcEzXEaVlrhv3yBSNRyaabXYAyiCV7xKHUH",
      "apiHost": "https://eu.posthog.com"
    }
  },
  "integrations": {
    "intercom": "rwqmvfqn"
  },
  "logo": {
    "light": "/images/logo/light.png",
    "dark": "/images/logo/dark.png",
    "href": "https://www.shuttle.dev/"
  },
  "layout": "topnav",
  "sidebar": { "items": "border" },
  "versions": [
    { "name": "🚀 shuttle.dev (NEW)", "url": "https://docs.shuttle.dev/" },
    { "name": "⚪ shuttle.rs", "url": "https://docs.shuttle.rs/" }
  ],
  "background": { "style": "windows" },
  "favicon": "/favicon.png",
  "colors": {
    "background": {
      "dark": "#0b0a00",
      "light": "#fcf0d0"
    },
    "primary": "#000",
    "light": "#f91",
    "dark": "#f91"
  },
  "topbarLinks": [
    { "name": "Support", "url": "https://docs.shuttle.dev/support/support" }
  ],
  "topbarCtaButton": {
    "style": "roundedRectangle",
    "type": "link",
    "name": "Log In",
    "url": "https://console.shuttle.dev/"
  },
  "anchors": [
    {
      "name": "GitHub",
      "icon": "github",
      "url": "https://github.com/shuttle-hq/shuttle"
    },
    {
      "name": "Community",
      "icon": "discord",
      "url": "https://discord.gg/shuttle"
    },
    {
      "name": "Crate Docs",
      "icon": "rust",
      "url": "https://docs.rs/shuttle-runtime/latest/shuttle_runtime/"
    }
  ],
  "tabs": [
    {
      "name": "Examples",
      "url": "examples"
    },
    {
      "name": "Templates and Tutorials",
      "url": "templates"
    },
    {
      "name": "Blog",
      "url": "https://www.shuttle.dev/blog/"
    }
  ],
  "navigation": [
    {
      "group": "Introduction",
      "pages": [
        "introduction/docs",
        "introduction/what-is-shuttle",
        "introduction/how-shuttle-works",
        {
          "group": "Platform Update",
          "icon": "layer-group",
          "pages": [
            "platform-update/platform-update",
            "platform-update/migration"
          ]
        },
        {
          "group": "Migrating to Shuttle",

          "icon": "dove",
          "pages": [
            "migrations/introduction",
            "migrations/migrating-checklist",
            "migrations/migrating-to-shuttle",
            {
              "group": "Frameworks",
              "pages": [
                "migrations/frameworks/axum",
                "migrations/frameworks/actix-web",
                "migrations/frameworks/rocket",
                "migrations/frameworks/custom-service"
              ]
            },
            {
              "group": "Infrastructure/Resources",
              "pages": [
                "migrations/resources/postgres",
                "migrations/resources/secrets"
              ]
            }
          ]
        }
      ]
    },
    {
      "group": "Getting Started",
      "pages": ["getting-started/installation", "getting-started/quick-start"]
    },
    {
      "group": "Shuttle",
      "pages": [
        "docs/projects",
        "docs/project-configuration",
        "docs/local-run",
        "docs/files",
        "docs/builds",
        "docs/deployment-environment",
        "docs/logs",
        "docs/domain-names"
      ]
    },
    {
      "group": "Resources",
      "pages": [
        "resources/resources",
        "resources/shuttle-secrets",
        {
          "group": "Databases",
          "icon": "database",
          "pages": ["resources/shuttle-shared-db"]
        }
      ]
    },
    {
      "group": "Integrations",
      "pages": [
        {
          "group": "Databases",
          "icon": "database",
          "pages": [
            "integrations/shuttle-turso",
            "integrations/shuttle-qdrant",
            "integrations/shuttle-opendal"
          ]
        },
        "integrations/shuttle-openai",
        "integrations/custom-resources",
        "integrations/ci-cd"
      ]
    },
    {
      "group": "Guides",
      "pages": [
        "guides/cli",
        "guides/upgrade",
        "guides/migrate-shared-postgres"
      ]
    },
    {
      "group": "Support",
      "pages": ["support/support", "support/faq", "support/troubleshooting"]
    },
    {
      "group": "Community",
      "pages": [
        "community/get-involved",
        "community/contribute",
        "community/open-source"
      ]
    },
    {
      "group": "Examples",
      "pages": [
        "examples/overview",
        {
          "group": "Axum",
          "pages": [
            "examples/axum",
            "examples/axum-postgres",
            "examples/axum-static-files",
            "examples/axum-websockets",
            "examples/axum-jwt-authentication"
          ]
        },
        {
          "group": "Actix Web",
          "pages": [
            "examples/actix",
            "examples/actix-postgres",
            "examples/actix-static-files",
            "examples/actix-websocket-actorless",
            "examples/actix-cookie-authentication"
          ]
        },
        {
          "group": "Rocket",
          "pages": [
            "examples/rocket",
            "examples/rocket-postgres",
            "examples/rocket-static-files",
            "examples/rocket-jwt-authentication"
          ]
        },
        {
          "group": "Serenity",
          "pages": [
            "examples/serenity",
            "examples/serenity-todo",
            "examples/poise"
          ]
        },
        "examples/other",
        "examples/examples-repo-link"
      ]
    },
    {
      "group": "Templates and Tutorials",
      "pages": ["templates/overview"]
    },
    {
      "group": "Fullstack Templates",
      "pages": ["templates/fullstack/saas-template"]
    },
    {
      "group": "Tutorials",
      "pages": [
        "templates/tutorials/rest-http-service-with-axum",
        "templates/tutorials/discord-weather-forecast",
        "templates/tutorials/databases-with-rust",
        "templates/tutorials/serverless-calendar-app",
        "templates/tutorials/url-shortener",
        "templates/tutorials/authentication",
        "templates/tutorials/send-your-logs-to-datadog",
        "templates/tutorials/websocket-chat-app-js",
        "templates/tutorials/custom-service"
      ]
    }
  ],
  "redirects": [
    {
      "source": "/introduction/platform-update",
      "destination": "/platform-update/platform-update"
    }
  ],
  "footerSocials": {
    "twitter": "https://twitter.com/shuttle_dev",
    "discord": "https://discord.com/invite/shuttle",
    "github": "https://github.com/shuttle-hq/shuttle"
  },
  "feedback": {
    "raiseIssue": true,
    "suggestEdit": true,
    "thumbsRating": true
  }
}