Spike: Add knowledge base (#119)

* Implement knowledge base mvp

* move to biome

* Update nav

* Update knowledge-base/kb-forwarding-emails.mdx

Co-authored-by: Andrew Blaney <[email protected]>

* Update knowledge-base/kb-personal-email.mdx

Co-authored-by: Andrew Blaney <[email protected]>

* Update kb-setup-time.mdx

* formatting

---------

Co-authored-by: Andrew Blaney <[email protected]>

.vscode/settings.json

@@ -1,3 +1,3 @@
 {
-  "editor.tabSize": 2
-}
+	"editor.tabSize": 2
+}

biome.config.json

@@ -0,0 +1,17 @@
+{
+	"$schema": "https://raw.githubusercontent.com/biomejs/biome/main/schema.json",
+	"files": {
+		"exclude": ["node_modules", "dist"]
+	},
+	"linter": {
+		"rules": {
+			"recommended": true
+		}
+	},
+	"formatter": {
+		"enabled": true
+	},
+	"organizeImports": {
+		"enabled": true
+	}
+}

custom.css

@@ -1,43 +1,43 @@
 /* Make logo smaller */
-#navbar img[src*='public/logo'] {
-  height: 22px;
+#navbar img[src*="public/logo"] {
+	height: 22px;
 }
 
 /* Global font weight adjustments */
 .font-extrabold {
-  font-weight: 600;
+	font-weight: 600;
 }
 
 .font-semibold {
-  font-weight: 500;
+	font-weight: 500;
 }
 
 /* By default h2s are very bold, this reduces the font-weight */
-.prose :where(h2):not(:where([class~='not-prose'] *)) {
-  font-weight: 600;
+.prose :where(h2):not(:where([class~="not-prose"] *)) {
+	font-weight: 600;
 }
 
 /* Within plain we never want a tighter leading than the default so override this globally. */
 .tracking-tight {
-  letter-spacing: 0;
+	letter-spacing: 0;
 }
 
 /* Remove tight leading on titles within the content */
-.prose :where(h1, h2, h3):not(:where([class~='not-prose'] *)) {
-  letter-spacing: initial;
+.prose :where(h1, h2, h3):not(:where([class~="not-prose"] *)) {
+	letter-spacing: initial;
 }
 
 /* Links that are in the content of the page */
-.prose :where(a):not(:where([class~='not-prose'] *)) {
-  font-weight: 500;
+.prose :where(a):not(:where([class~="not-prose"] *)) {
+	font-weight: 500;
 }
 
 /* Prevent layout shift from scrollbar appearing */
 html {
-  overflow-y: scroll;
+	overflow-y: scroll;
 }
 
 /* Hide sidebar scrollbar */
 #sidebar::-webkit-scrollbar {
-  display: none;
+	display: none;
 }

knowledge-base/kb-forwarding-emails.mdx

@@ -0,0 +1,24 @@
+---
+title: Can I forward emails to Plain?
+---
+
+No. If you receive an email to your personal email address and would like to hand it off to support what you can do is **CC** your support email. 
+
+For example, if [email protected] is your support email, your email exchange could look like this:
+
+---
+
+**From**: [email protected]<br/>
+**To**: You<br/>
+
+> Can you help me with A, B & C.
+
+---
+
+**From**: You<br/>
+**To**: [email protected]<br/> 
+**Cc**: [email protected] 👈<br/>
+
+> Hey Jane, sure thing. Just looping in our support team here (CCd) who can help you out!
+
+---

knowledge-base/kb-personal-email.mdx

@@ -0,0 +1,7 @@
+---
+title: Can I connect my personal email address to Plain?
+---
+
+Technically you can connect any email to Plain if you control the domain (e.g. not @hotmail.com) but we don't recommend using a personal email. The reason for this is that emails are visible to all users of Plain in your workspace. 
+
+Visibility aside, we are focused on providing support via email and so Plain is not well suited for personal email address workflows.

knowledge-base/kb-setup-time.mdx

@@ -0,0 +1,9 @@
+---
+title: How long does it take to set up Plain? Do I need to have someone technical do it for me?
+---
+
+If you are setting up Plain to handle your Slack support it only takes a few minutes. You have to add a Slack app to your workspace and then invite Plain to the channels you want to handle. For detailed instructions [read the docs](/slack).
+
+The Plain App will walk you throught this process or we can help you onboard in a quick 15 minute call.
+
+If you want to set-up Plain via email you need a bit more time and need to be able to add DNS records to your domain. For more info on how to set up email, [read the docs](/email).

knowledge-base/kb-soc2.mdx

@@ -0,0 +1,7 @@
+---
+title: Are you SOC2 certified?
+---
+
+Yes. We are SOC2 Type II compliant. On request we can share our lates SOC2 report as well as our latest pen test and other associated documentation. 
+
+We are also GDPR compliant. You can read more high-level information on our security approach [here](/security).

knowledge-base/overview.mdx

@@ -0,0 +1,17 @@
+---
+title: Knowledge Base
+sidebarTitle: Overview
+---
+
+<Note>**Beta**: We're just in the process of building out our knowledge base. A lot more coming soon</Note>
+
+
+### Setup
+- [How long does it take to set up Plain? Do I need to have someone technical do it for me?](./kb-setup-time)
+
+### Email
+- [Can I connect my personal email address to Plain?](./kb-personal-email)
+- [Can I forward emails to Plain?](./kb-forwarding-emails)
+
+### Security
+- [Are you SOC2 certified?](./kb-soc2)

mint.json

@@ -39,12 +39,21 @@
 		}
 	],
 	"tabs": [
+		{
+			"name": "Knowledge Base",
+			"url": "knowledge-base"
+		},
 		{
 			"name": "API Reference",
 			"url": "api-reference"
 		}
 	],
 	"anchors": [
+		{
+			"name": "Knowledge Base",
+			"icon": "books",
+			"url": "knowledge-base"
+		},
 		{
 			"name": "Changelog",
 			"icon": "code-commit",
@@ -54,21 +63,12 @@
 			"name": "Blog",
 			"icon": "quote-right",
 			"url": "https://plain.com/blog"
-		},
-		{
-			"name": "Book a demo",
-			"icon": "calendar",
-			"url": "https://cal.com/team/plain/demo"
 		}
 	],
 	"navigation": [
 		{
 			"group": "Plain 101",
-			"pages": [
-				"quickstart",
-				"data-model",
-				"security"
-			]
+			"pages": ["quickstart", "data-model", "security"]
 		},
 		{
 			"group": "Channels",
@@ -85,25 +85,15 @@
 				},
 				{
 					"group": "Slack",
-					"pages": [
-						"slack",
-						"slack/ingestion-modes",
-						"slack/data-retention"
-					]
+					"pages": ["slack", "slack/ingestion-modes", "slack/data-retention"]
 				},
 				{
 					"group": "Chat",
-					"pages": [
-						"chat",
-						"chat/authentication"
-					]
+					"pages": ["chat", "chat/authentication"]
 				},
 				{
 					"group": "Microsoft Teams",
-					"pages": [
-						"microsoft-teams",
-						"microsoft-teams/installation"
-					]
+					"pages": ["microsoft-teams", "microsoft-teams/installation"]
 				},
 				"contact-forms",
 				"headless-support-portal"
@@ -301,6 +291,16 @@
 				},
 				"api-reference/attachments"
 			]
+		},
+		{
+			"group": "Knowledge Base",
+			"pages": [
+				"knowledge-base/overview",
+				"knowledge-base/kb-personal-email",
+				"knowledge-base/kb-setup-time",
+				"knowledge-base/kb-soc2",
+				"knowledge-base/kb-forwarding-emails"
+			]
 		}
 	],
 	"footerSocials": {
@@ -314,4 +314,4 @@
 			"destination": "/headless-support-portal"
 		}
 	]
-}
+}

package.json

@@ -9,22 +9,22 @@
 	},
 	"scripts": {
 		"dev": "mintlify dev",
-		"lint": "pnpm run lint:prettier && pnpm run lint:links",
+		"lint": "pnpm run lint:biome && pnpm run lint:links",
 		"lint:snippets": "tsx scripts/validateWebhookSnippets.ts",
 		"lint:links": "mintlify broken-links",
-		"lint:prettier": "prettier --check './**/*.{js,ts,tsx,md,mdx}'",
-		"lint:fix": "prettier --write './**/*.{js,ts,tsx,md,mdx}'",
+		"lint:biome": "biome check",
+		"lint:fix": "biome check --write",
 		"format": "prettier --write './**/*.{js,ts,tsx,md,mdx}'"
 	},
 	"dependencies": {
 		"ajv-formats": "^3.0.1",
-		"mintlify": "^4.0.82",
-		"prettier": "^3.1.0"
+		"mintlify": "^4.0.82"
 	},
 	"devDependencies": {
+		"@biomejs/biome": "^1.9.4",
 		"@types/ajv": "^1.0.0",
 		"@types/node": "^22.5.5",
 		"ajv": "^8.17.1",
 		"tsx": "^4.19.1"
 	}
-}
+}