Skip to content

armgit / kaneo

Public Imported from GitHub
0

⚡ Project management that doesn't become the project. Boards, Gantt charts, and GitHub integration. Self-host it or use Kaneo Cloud.

docs: update documentation structure

Andrej Acevskiabcdd86f0a57
diff --git a/apps/docs/app/(home)/page.tsx b/apps/docs/app/(home)/page.tsx
index ac7e1b380..caa07ebd1 100644
--- a/apps/docs/app/(home)/page.tsx
+++ b/apps/docs/app/(home)/page.tsx
@@ -11,6 +11,7 @@ export default function HomePage() {
<main className="relative">
<StructuredData type="organization" />
<StructuredData type="software" />
+ <StructuredData type="website" />
<StructuredData type="faq" />
<div className="relative">
diff --git a/apps/docs/app/icon.svg b/apps/docs/app/icon.svg
deleted file mode 100644
index c5e259f8d..000000000
--- a/apps/docs/app/icon.svg
+++ /dev/null
@@ -1,7 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" width="104" height="104"><svg width="104" height="104" viewBox="0 0 104 104" fill="none" xmlns="http://www.w3.org/2000/svg">
-<path d="M14.6855 95.7248C10.5715 96.5962 8 95.2648 8 93.6603L8 62.0256C8 61.8599 8.00322 61.6859 8.00879 61.507C8.00389 61.3849 8.00098 61.2491 8.00098 61.0978L8.00098 29.9435C8.01505 28.6517 8.259 27.7441 11.2588 27.1086L25.3145 24.2756C29.4285 23.4041 32 24.7356 32 26.34L32 57.9748C32 58.1411 31.9978 58.3157 31.9922 58.4953C31.997 58.6169 31.999 58.7521 31.999 58.9025L31.999 90.0568C31.985 91.3487 31.7411 92.2563 28.7412 92.8918L14.6855 95.7248Z" fill="#5463FF"></path>
-<path d="M46.6855 87.7243C42.572 88.5956 40.0005 87.265 40 85.6608L40 54.0261C40 53.8601 40.0032 53.6858 40.0088 53.5065C40.0039 53.3845 40.001 53.2484 40.001 53.0973L40.001 21.944C40.0151 20.6524 40.2592 19.7445 43.2588 19.1091L57.3145 16.277C61.4284 15.4056 63.9999 16.7362 64 18.3405L64 49.9753C64 50.1412 63.9978 50.3156 63.9922 50.4948C63.9971 50.6166 63.999 50.7522 63.999 50.903L63.999 82.0563C63.985 83.3483 63.7412 84.2558 60.7412 84.8913L46.6855 87.7243Z" fill="#5463FF"></path>
-<path d="M89.3145 8.27435C93.4281 7.40301 95.9996 8.73456 96 10.3388V21.1845L78.0576 44.5009L95.999 66.7792V74.0566C95.9849 75.3482 95.7407 76.2561 92.7412 76.8915L78.6855 79.7236C74.5716 80.595 72.0001 79.2645 72 77.6601V46.0253C72 45.8596 72.0032 45.6848 72.0088 45.5058C72.0039 45.3838 72.001 45.2477 72.001 45.0966V13.9423C72.0151 12.6507 72.2593 11.7428 75.2588 11.1074L89.3145 8.27435Z" fill="#5463FF"></path>
-</svg><style>@media (prefers-color-scheme: light) { :root { filter: none; } }
-@media (prefers-color-scheme: dark) { :root { filter: none; } }
-</style></svg>
\ No newline at end of file
diff --git a/apps/docs/app/layout.tsx b/apps/docs/app/layout.tsx
index 2a996531c..099e2eb02 100644
--- a/apps/docs/app/layout.tsx
+++ b/apps/docs/app/layout.tsx
@@ -27,8 +27,25 @@ export const metadata: Metadata = {
"gantt chart",
"jira alternative",
"asana alternative",
+ "linear alternative",
+ "plane alternative",
+ "monday alternative",
+ "clickup alternative",
"productivity",
"docker",
+ "issue tracking",
+ "agile",
+ "scrum",
+ "sprint planning",
+ "project tracking",
+ "bug tracking",
+ "workflow management",
+ "devops",
+ "github integration",
+ "REST API",
+ "open source project management",
+ "free project management",
+ "self-hosted project management",
],
authors: [{ name: "Andrej Acevski" }],
creator: "Andrej Acevski",
@@ -70,17 +87,12 @@ export const metadata: Metadata = {
index: true,
follow: true,
"max-video-preview": -1,
- "max-image-preview": "none",
+ "max-image-preview": "large",
"max-snippet": -1,
},
},
alternates: {
canonical: "https://kaneo.app",
- types: {
- "application/rss+xml": [
- { url: "/feed.xml", title: "Kaneo Blog RSS Feed" },
- ],
- },
},
category: "technology",
};
@@ -89,22 +101,22 @@ export default function Layout({ children }: { children: ReactNode }) {
return (
<html lang="en" className={inter.className} suppressHydrationWarning>
<head>
+ <link rel="icon" type="image/x-icon" href="/favicon.ico?v=2" />
<link
rel="icon"
type="image/png"
- href="/favicon-96x96.png"
+ href="/favicon-96x96.png?v=2"
sizes="96x96"
/>
- <link rel="shortcut icon" href="/favicon.ico" />
<link
rel="apple-touch-icon"
sizes="180x180"
- href="/apple-touch-icon.png"
+ href="/apple-touch-icon.png?v=2"
/>
<meta name="apple-mobile-web-app-title" content="Kaneo" />
<link rel="manifest" href="/manifest.json" />
<link rel="sitemap" type="application/xml" href="/sitemap.xml" />
- <meta name="theme-color" content="#4f46e5" />
+ <meta name="theme-color" content="#5463FF" />
<meta name="color-scheme" content="light dark" />
</head>
<body className="flex flex-col min-h-screen">
diff --git a/apps/docs/app/sitemap.ts b/apps/docs/app/sitemap.ts
index 34b464e11..f9d1272d1 100644
--- a/apps/docs/app/sitemap.ts
+++ b/apps/docs/app/sitemap.ts
@@ -6,12 +6,21 @@ export default function sitemap(): MetadataRoute.Sitemap {
const baseUrl = "https://kaneo.app";
const staticPages = [
+ // Homepage
{
url: baseUrl,
lastModified: new Date(),
changeFrequency: "weekly" as const,
priority: 1,
},
+ {
+ url: "https://cloud.kaneo.app/public-project/vlu4ak2w8rs9rn1r4lirj2u1",
+ lastModified: new Date(),
+ changeFrequency: "weekly" as const,
+ priority: 1,
+ },
+
+ // Main sections
{
url: `${baseUrl}/docs/core`,
lastModified: new Date(),
@@ -19,64 +28,470 @@ export default function sitemap(): MetadataRoute.Sitemap {
priority: 0.9,
},
{
- url: `${baseUrl}/docs/integrations/github`,
+ url: `${baseUrl}/docs/api`,
+ lastModified: new Date(),
+ changeFrequency: "weekly" as const,
+ priority: 0.9,
+ },
+ {
+ url: `${baseUrl}/docs/core/alternatives`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.9,
+ },
+
+ // Installation
+ {
+ url: `${baseUrl}/docs/core/installation`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.9,
+ },
+ {
+ url: `${baseUrl}/docs/core/installation/docker-compose`,
lastModified: new Date(),
changeFrequency: "monthly" as const,
priority: 0.8,
},
{
- url: `${baseUrl}/docs/deployments/nginx`,
+ url: `${baseUrl}/docs/core/installation/drim`,
lastModified: new Date(),
changeFrequency: "monthly" as const,
priority: 0.8,
},
{
- url: `${baseUrl}/docs/deployments/traefik`,
+ url: `${baseUrl}/docs/core/installation/environment-variables`,
lastModified: new Date(),
changeFrequency: "monthly" as const,
priority: 0.8,
},
{
- url: `${baseUrl}/docs/deployments/kubernetes`,
+ url: `${baseUrl}/docs/core/installation/start-services`,
lastModified: new Date(),
changeFrequency: "monthly" as const,
priority: 0.8,
},
+
+ // Integrations
+ {
+ url: `${baseUrl}/docs/core/integrations/github`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.8,
+ },
+ {
+ url: `${baseUrl}/docs/core/integrations/github/setup`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.7,
+ },
{
- url: `${baseUrl}/docs/terminology`,
+ url: `${baseUrl}/docs/core/integrations/github/configuration`,
lastModified: new Date(),
changeFrequency: "monthly" as const,
priority: 0.7,
},
{
- url: `${baseUrl}/docs/terminology/projects`,
+ url: `${baseUrl}/docs/core/integrations/github/troubleshooting`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.7,
+ },
+
+ // Social Providers
+ {
+ url: `${baseUrl}/docs/core/social-providers/github`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.8,
+ },
+ {
+ url: `${baseUrl}/docs/core/social-providers/google`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.8,
+ },
+ {
+ url: `${baseUrl}/docs/core/social-providers/discord`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.8,
+ },
+ {
+ url: `${baseUrl}/docs/core/social-providers/custom-oauth`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.8,
+ },
+
+ // Reverse Proxy
+ {
+ url: `${baseUrl}/docs/core/reverse-proxy/nginx`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.8,
+ },
+
+ // Deployments
+ {
+ url: `${baseUrl}/docs/core/deployments/railway`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.8,
+ },
+
+ // Guide
+ {
+ url: `${baseUrl}/docs/core/guide/migrating-from-v1`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.8,
+ },
+
+ // API Documentation
+ {
+ url: `${baseUrl}/docs/api/authentication`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.9,
+ },
+ {
+ url: `${baseUrl}/docs/api/getConfig`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.7,
+ },
+ {
+ url: `${baseUrl}/docs/api/globalSearch`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.7,
+ },
+
+ // Projects API
+ {
+ url: `${baseUrl}/docs/api/projects/listProjects`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.8,
+ },
+ {
+ url: `${baseUrl}/docs/api/projects/createProject`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.7,
+ },
+ {
+ url: `${baseUrl}/docs/api/projects/getProject`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.7,
+ },
+ {
+ url: `${baseUrl}/docs/api/projects/updateProject`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.7,
+ },
+ {
+ url: `${baseUrl}/docs/api/projects/deleteProject`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.7,
+ },
+
+ // Tasks API
+ {
+ url: `${baseUrl}/docs/api/tasks/listTasks`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.8,
+ },
+ {
+ url: `${baseUrl}/docs/api/tasks/createTask`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.7,
+ },
+ {
+ url: `${baseUrl}/docs/api/tasks/getTask`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.7,
+ },
+ {
+ url: `${baseUrl}/docs/api/tasks/updateTask`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.7,
+ },
+ {
+ url: `${baseUrl}/docs/api/tasks/deleteTask`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.7,
+ },
+ {
+ url: `${baseUrl}/docs/api/tasks/updateTaskTitle`,
lastModified: new Date(),
changeFrequency: "monthly" as const,
priority: 0.6,
},
{
- url: `${baseUrl}/docs/terminology/workspaces`,
+ url: `${baseUrl}/docs/api/tasks/updateTaskDescription`,
lastModified: new Date(),
changeFrequency: "monthly" as const,
priority: 0.6,
},
{
- url: `${baseUrl}/docs/terminology/tasks`,
+ url: `${baseUrl}/docs/api/tasks/updateTaskStatus`,
lastModified: new Date(),
changeFrequency: "monthly" as const,
priority: 0.6,
},
{
- url: `${baseUrl}/docs/roadmap`,
+ url: `${baseUrl}/docs/api/tasks/updateTaskPriority`,
lastModified: new Date(),
- changeFrequency: "weekly" as const,
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+ {
+ url: `${baseUrl}/docs/api/tasks/updateTaskDueDate`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+ {
+ url: `${baseUrl}/docs/api/tasks/updateTaskAssignee`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+ {
+ url: `${baseUrl}/docs/api/tasks/importTasks`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+ {
+ url: `${baseUrl}/docs/api/tasks/exportTasks`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+ {
+ url: `${baseUrl}/docs/api/tasks/getTaskLabels`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+ {
+ url: `${baseUrl}/docs/api/tasks/getTaskTimeEntries`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+
+ // Labels API
+ {
+ url: `${baseUrl}/docs/api/labels/getWorkspaceLabels`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
priority: 0.7,
},
{
- url: `${baseUrl}/docs/alternatives`,
+ url: `${baseUrl}/docs/api/labels/getTaskLabels`,
lastModified: new Date(),
changeFrequency: "monthly" as const,
- priority: 0.9,
+ priority: 0.7,
+ },
+ {
+ url: `${baseUrl}/docs/api/labels/createLabel`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+ {
+ url: `${baseUrl}/docs/api/labels/getLabel`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+ {
+ url: `${baseUrl}/docs/api/labels/updateLabel`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+ {
+ url: `${baseUrl}/docs/api/labels/deleteLabel`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+
+ // Time Entries API
+ {
+ url: `${baseUrl}/docs/api/time-entries/getTaskTimeEntries`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.7,
+ },
+ {
+ url: `${baseUrl}/docs/api/time-entries/createTimeEntry`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+ {
+ url: `${baseUrl}/docs/api/time-entries/getTimeEntry`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+ {
+ url: `${baseUrl}/docs/api/time-entries/updateTimeEntry`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+
+ // Activities API
+ {
+ url: `${baseUrl}/docs/api/activities/getActivities`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.7,
+ },
+ {
+ url: `${baseUrl}/docs/api/activities/createActivity`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+
+ // Comments API
+ {
+ url: `${baseUrl}/docs/api/comments/createComment`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.7,
+ },
+ {
+ url: `${baseUrl}/docs/api/comments/updateComment`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+ {
+ url: `${baseUrl}/docs/api/comments/deleteComment`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+
+ // Notifications API
+ {
+ url: `${baseUrl}/docs/api/notifications/listNotifications`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.7,
+ },
+ {
+ url: `${baseUrl}/docs/api/notifications/createNotification`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+ {
+ url: `${baseUrl}/docs/api/notifications/markNotificationAsRead`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+ {
+ url: `${baseUrl}/docs/api/notifications/markAllNotificationsAsRead`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+ {
+ url: `${baseUrl}/docs/api/notifications/clearAllNotifications`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+
+ // Invitations API
+ {
+ url: `${baseUrl}/docs/api/invitations/getUserPendingInvitations`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.7,
+ },
+ {
+ url: `${baseUrl}/docs/api/invitations/getInvitationDetails`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+
+ // External Links API
+ {
+ url: `${baseUrl}/docs/api/external-links/getExternalLinksByTask`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+
+ // GitHub Integration API
+ {
+ url: `${baseUrl}/docs/api/github-integration/getGitHubAppInfo`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.7,
+ },
+ {
+ url: `${baseUrl}/docs/api/github-integration/listGitHubRepositories`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.7,
+ },
+ {
+ url: `${baseUrl}/docs/api/github-integration/verifyGitHubInstallation`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.7,
+ },
+ {
+ url: `${baseUrl}/docs/api/github-integration/getGitHubIntegration`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+ {
+ url: `${baseUrl}/docs/api/github-integration/createGitHubIntegration`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+ {
+ url: `${baseUrl}/docs/api/github-integration/updateGitHubIntegration`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+ {
+ url: `${baseUrl}/docs/api/github-integration/deleteGitHubIntegration`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.6,
+ },
+ {
+ url: `${baseUrl}/docs/api/github-integration/importGitHubIssues`,
+ lastModified: new Date(),
+ changeFrequency: "monthly" as const,
+ priority: 0.7,
},
];
diff --git a/apps/docs/components/footer.tsx b/apps/docs/components/footer.tsx
index 5bcd8b6de..d5043b93f 100644
--- a/apps/docs/components/footer.tsx
+++ b/apps/docs/components/footer.tsx
@@ -73,7 +73,9 @@ export default function Footer() {
</Link>
<Link
className="text-muted-foreground hover:text-primary block duration-150"
- href="/docs/roadmap"
+ href="https://cloud.kaneo.app/public-project/vlu4ak2w8rs9rn1r4lirj2u1"
+ target="_blank"
+ rel="noopener noreferrer"
>
<span>Roadmap</span>
</Link>
diff --git a/apps/docs/components/structured-data.tsx b/apps/docs/components/structured-data.tsx
index 2d4566310..9e4b0196d 100644
--- a/apps/docs/components/structured-data.tsx
+++ b/apps/docs/components/structured-data.tsx
@@ -1,7 +1,14 @@
import Script from "next/script";
type StructuredDataProps = {
- type?: "organization" | "software" | "article" | "faq";
+ type?:
+ | "organization"
+ | "software"
+ | "article"
+ | "faq"
+ | "website"
+ | "breadcrumb"
+ | "techarticle";
data?: {
title?: string;
description?: string;
@@ -12,6 +19,10 @@ type StructuredDataProps = {
question: string;
answer: string;
}>;
+ breadcrumbs?: Array<{
+ name: string;
+ url: string;
+ }>;
};
};
@@ -141,6 +152,51 @@ export default function StructuredData({
],
};
+ case "website":
+ return {
+ ...baseData,
+ "@type": "WebSite",
+ name: "Kaneo",
+ url: "https://kaneo.app",
+ description:
+ "Open source project management that works for you, not against you. Self-hosted, simple, and powerful.",
+ };
+
+ case "breadcrumb":
+ return {
+ ...baseData,
+ "@type": "BreadcrumbList",
+ itemListElement: (data?.breadcrumbs || []).map((item, index) => ({
+ "@type": "ListItem",
+ position: index + 1,
+ name: item.name,
+ item: item.url,
+ })),
+ };
+
+ case "techarticle":
+ return {
+ ...baseData,
+ "@type": "TechArticle",
+ headline: data?.title || "Kaneo Documentation",
+ description: data?.description || "Technical documentation for Kaneo",
+ author: {
+ "@type": "Organization",
+ name: "Kaneo",
+ },
+ publisher: {
+ "@type": "Organization",
+ name: "Kaneo",
+ logo: {
+ "@type": "ImageObject",
+ url: "https://kaneo.app/logo.png",
+ },
+ },
+ datePublished: data?.datePublished || new Date().toISOString(),
+ dateModified: data?.dateModified || new Date().toISOString(),
+ url: data?.url || "https://kaneo.app/docs",
+ };
+
default:
return baseData;
}
diff --git a/apps/docs/public/logo.png b/apps/docs/public/logo.png
new file mode 100644
index 000000000..0e672dfbd
Binary files /dev/null and b/apps/docs/public/logo.png differ