diff --git a/README.md b/README.md index 22563b08..2ca1a116 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ · Website · - Docs + Docs · Discord

diff --git a/apps/docs/api-reference/introduction.mdx b/apps/docs/api-reference/introduction.mdx index 00854700..f9a9e59b 100644 --- a/apps/docs/api-reference/introduction.mdx +++ b/apps/docs/api-reference/introduction.mdx @@ -6,15 +6,15 @@ description: "Learn how to integrate with Kan's REST API." ## Base URL ``` -https://kanbn.com/api/v1 +https://kan.bn/api/v1 ``` ## 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 diff --git a/apps/docs/api-reference/openapi.json b/apps/docs/api-reference/openapi.json deleted file mode 100644 index b1509be0..00000000 --- a/apps/docs/api-reference/openapi.json +++ /dev/null @@ -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" - } - } - } -} \ No newline at end of file diff --git a/apps/docs/introduction.mdx b/apps/docs/introduction.mdx index a1f2ab1d..08a7eb11 100644 --- a/apps/docs/introduction.mdx +++ b/apps/docs/introduction.mdx @@ -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 instantly with our hosted solution - we'll handle all the hosting, scaling, and maintenance for you. - + For full data ownership and control, you can self-host Kan on your infrastructure. diff --git a/apps/docs/mint.json b/apps/docs/mint.json index ae6e5c8e..e741000f 100644 --- a/apps/docs/mint.json +++ b/apps/docs/mint.json @@ -4,7 +4,7 @@ "logo": { "dark": "/logo/dark.svg", "light": "/logo/light.svg", - "href": "https://kanbn.com" + "href": "https://kan.bn" }, "favicon": "./favicon.png", "colors": { @@ -19,17 +19,17 @@ "topbarLinks": [ { "name": "Sign in", - "url": "https://kanbn.com/login" + "url": "https://kan.bn/login" } ], "topbarCtaButton": { "name": "Go to app", - "url": "https://kanbn.com/boards" + "url": "https://kan.bn/boards" }, "anchors": [ { "name": "API Reference", - "openapi": "https://www.kanbn.com/api/v1/openapi.json", + "openapi": "https://kan.bn/api/v1/openapi.json", "url": "api-reference", "icon": "square-terminal" }, diff --git a/apps/docs/package.json b/apps/docs/package.json index 1edf62d6..df831bdd 100644 --- a/apps/docs/package.json +++ b/apps/docs/package.json @@ -6,7 +6,7 @@ "scripts": { "build": "pnpm with-env mint build", "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", "lint": "eslint", "typecheck": "tsc --noEmit", diff --git a/apps/web/src/components/FeedbackButton.tsx b/apps/web/src/components/FeedbackButton.tsx index 7627cd2e..4495cd57 100644 --- a/apps/web/src/components/FeedbackButton.tsx +++ b/apps/web/src/components/FeedbackButton.tsx @@ -110,14 +110,14 @@ const FeedbackButton: React.FC = () => {

Need help?{" "} Contact us , or see our{" "} { { label: "Roadmap", href: "/kan/roadmap", openInNewTab: true }, { label: "Features", href: "#features" }, { label: "Pricing", href: "#pricing" }, - { label: "Docs", href: "https://docs.kanbn.com", openInNewTab: true }, + { label: "Docs", href: "https://docs.kan.bn", openInNewTab: true }, ]; useEffect(() => {