fix: set correct urls in docs

This commit is contained in:
Henry
2025-06-01 21:05:09 +01:00
parent 4d4a19ad7b
commit 6279138c04
8 changed files with 14 additions and 209 deletions

View File

@@ -10,7 +10,7 @@
· ·
<a href="https://kan.bn">Website</a> <a href="https://kan.bn">Website</a>
· ·
<a href="https://docs.kanbn.com">Docs</a> <a href="https://docs.kan.bn">Docs</a>
· ·
<a href="https://discord.gg/e6ejRb6CmT">Discord</a> <a href="https://discord.gg/e6ejRb6CmT">Discord</a>
</p> </p>

View File

@@ -6,15 +6,15 @@ description: "Learn how to integrate with Kan's REST API."
## Base URL ## Base URL
``` ```
https://kanbn.com/api/v1 https://kan.bn/api/v1
``` ```
## Authentication ## Authentication
Most endpoints require authentication using Bearer tokens. You can get this from the `sb-kanbn-auth-token.0` cookie in your browser. Include this token in the Authorization header of each request. Most endpoints require authentication using your API key. You can create one in the [settings page](https://kan.bn/settings) of your account. Include this key in the `x-api-key` header of each request.
``` ```
Authorization: Bearer 123456789 'x-api-key': kan_123456789
``` ```
## Response codes ## Response codes

View File

@@ -1,195 +0,0 @@
{
"openapi": "3.0.1",
"info": {
"title": "OpenAPI Plant Store",
"description": "A sample API that uses a plant store as an example to demonstrate features in the OpenAPI specification",
"license": {
"name": "MIT"
},
"version": "1.0.0"
},
"servers": [
{
"url": "http://sandbox.mintlify.com"
}
],
"security": [
{
"bearerAuth": []
}
],
"paths": {
"/plants": {
"get": {
"description": "Returns all plants from the system that the user has access to",
"parameters": [
{
"name": "limit",
"in": "query",
"description": "The maximum number of results to return",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Plant response",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Plant"
}
}
}
}
},
"400": {
"description": "Unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
},
"post": {
"description": "Creates a new plant in the store",
"requestBody": {
"description": "Plant to add to the store",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewPlant"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "plant response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Plant"
}
}
}
},
"400": {
"description": "unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
},
"/plants/{id}": {
"delete": {
"description": "Deletes a single plant based on the ID supplied",
"parameters": [
{
"name": "id",
"in": "path",
"description": "ID of plant to delete",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"204": {
"description": "Plant deleted",
"content": {}
},
"400": {
"description": "unexpected error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Plant": {
"required": [
"name"
],
"type": "object",
"properties": {
"name": {
"description": "The name of the plant",
"type": "string"
},
"tag": {
"description": "Tag to specify the type",
"type": "string"
}
}
},
"NewPlant": {
"allOf": [
{
"$ref": "#/components/schemas/Plant"
},
{
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"description": "Identification number of the plant",
"type": "integer",
"format": "int64"
}
}
}
]
},
"Error": {
"required": [
"error",
"message"
],
"type": "object",
"properties": {
"error": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
}
}
}
},
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer"
}
}
}
}

View File

@@ -21,11 +21,11 @@ description: "Kan is the open source alternative to Trello."
Get started with Kan by choosing your preferred deployment option below. Get started with Kan by choosing your preferred deployment option below.
<CardGroup cols={2}> <CardGroup cols={2}>
<Card title="Cloud" icon="cloud" href="https://kanbn.com/signup"> <Card title="Cloud" icon="cloud" href="https://kan.bn/signup">
Get started instantly with our hosted solution - we'll handle all the Get started instantly with our hosted solution - we'll handle all the
hosting, scaling, and maintenance for you. hosting, scaling, and maintenance for you.
</Card> </Card>
<Card title="Self-host" icon="code" href="https://kanbn.com/docs/self-host"> <Card title="Self-host" icon="code" href="https://kan.bn/docs/self-host">
For full data ownership and control, you can self-host Kan on your For full data ownership and control, you can self-host Kan on your
infrastructure. infrastructure.
</Card> </Card>

View File

@@ -4,7 +4,7 @@
"logo": { "logo": {
"dark": "/logo/dark.svg", "dark": "/logo/dark.svg",
"light": "/logo/light.svg", "light": "/logo/light.svg",
"href": "https://kanbn.com" "href": "https://kan.bn"
}, },
"favicon": "./favicon.png", "favicon": "./favicon.png",
"colors": { "colors": {
@@ -19,17 +19,17 @@
"topbarLinks": [ "topbarLinks": [
{ {
"name": "Sign in", "name": "Sign in",
"url": "https://kanbn.com/login" "url": "https://kan.bn/login"
} }
], ],
"topbarCtaButton": { "topbarCtaButton": {
"name": "Go to app", "name": "Go to app",
"url": "https://kanbn.com/boards" "url": "https://kan.bn/boards"
}, },
"anchors": [ "anchors": [
{ {
"name": "API Reference", "name": "API Reference",
"openapi": "https://www.kanbn.com/api/v1/openapi.json", "openapi": "https://kan.bn/api/v1/openapi.json",
"url": "api-reference", "url": "api-reference",
"icon": "square-terminal" "icon": "square-terminal"
}, },

View File

@@ -6,7 +6,7 @@
"scripts": { "scripts": {
"build": "pnpm with-env mint build", "build": "pnpm with-env mint build",
"clean": "git clean -xdf .cache .turbo node_modules", "clean": "git clean -xdf .cache .turbo node_modules",
"dev": "pnpm with-env mintlify dev", "dev": "pnpm with-env mintlify dev --port 3001",
"format": "prettier --check . --ignore-path ../../.gitignore", "format": "prettier --check . --ignore-path ../../.gitignore",
"lint": "eslint", "lint": "eslint",
"typecheck": "tsc --noEmit", "typecheck": "tsc --noEmit",

View File

@@ -110,14 +110,14 @@ const FeedbackButton: React.FC = () => {
<p className="ml-2 text-xs text-neutral-900 dark:text-dark-1000"> <p className="ml-2 text-xs text-neutral-900 dark:text-dark-1000">
Need help?{" "} Need help?{" "}
<Link <Link
href="mailto:support@kanbn.com" href="mailto:support@kan.bn"
className="text-blue-600 underline dark:text-blue-300" className="text-blue-600 underline dark:text-blue-300"
> >
Contact us Contact us
</Link> </Link>
, or see our{" "} , or see our{" "}
<Link <Link
href="https://docs.kanbn.com" href="https://docs.kan.bn"
target="_blank" target="_blank"
rel="noreferrer" rel="noreferrer"
className="text-blue-600 underline dark:text-blue-300" className="text-blue-600 underline dark:text-blue-300"

View File

@@ -12,7 +12,7 @@ const Header = ({ isLoggedIn }: { isLoggedIn: boolean }) => {
{ label: "Roadmap", href: "/kan/roadmap", openInNewTab: true }, { label: "Roadmap", href: "/kan/roadmap", openInNewTab: true },
{ label: "Features", href: "#features" }, { label: "Features", href: "#features" },
{ label: "Pricing", href: "#pricing" }, { label: "Pricing", href: "#pricing" },
{ label: "Docs", href: "https://docs.kanbn.com", openInNewTab: true }, { label: "Docs", href: "https://docs.kan.bn", openInNewTab: true },
]; ];
useEffect(() => { useEffect(() => {