From 53e07eb0477be5b06aa7549a2267cb220cfa4487 Mon Sep 17 00:00:00 2001 From: rizzhal Date: Thu, 13 Aug 2026 00:32:49 +0530 Subject: [PATCH 1/6] redesign documentation page --- app/documentation/page.tsx | 119 +++++++++++++++++++++++++++++-------- 1 file changed, 95 insertions(+), 24 deletions(-) diff --git a/app/documentation/page.tsx b/app/documentation/page.tsx index 92378150..dae5c7d7 100644 --- a/app/documentation/page.tsx +++ b/app/documentation/page.tsx @@ -3,10 +3,27 @@ import path from "path" import matter from "gray-matter" import Link from "next/link" import { ContentWithToc } from "@/components/content-with-toc" +import { ArrowRight, BookOpen, FileText, Package, Printer, ScanLine, Settings } from "lucide-react" const PAGE_MD = path.join(process.cwd(), "contents", "pages", "documentation.md") const DOCS_DIR = path.join(process.cwd(), "contents", "documentation") +const iconsMap = { + "01-printer-application": Printer, + "02-designing-printer-drivers": Settings, + "03-designing-scanner-drivers": ScanLine, + "04-packaging-drivers": Package, + "05-User-Manual": BookOpen +} as const + +const descriptionMap = { + "01-printer-application": "Explore how Printer Applications simplify and enhance printing in Linux.", + "02-designing-printer-drivers": "Learn the essentials of building reliable and efficient printer drivers.", + "03-designing-scanner-drivers": "Guidelines and best practices for creating scanner drivers.", + "04-packaging-drivers": "Step-by-step guide to package your drivers and publish to the Snap Store.", + "05-User-Manual": "Comprehensive user manual for Printer Applications.", +} as const + export default async function DocumentationPage() { const raw = await fs.readFile(PAGE_MD, "utf8") const { data, content } = matter(raw) @@ -32,33 +49,87 @@ export default async function DocumentationPage() { const hasContent = content != null && content.trim().length > 0 - return ( -
-
-

- {typeof data.title === "string" ? data.title : "Documentation"} -

+ return ( +
+
+ + {/* Documentation header */} +
+
+
+ +
+ +

+ {typeof data.title === "string" + ? data.title + : "Documentation"} +

+
{hasContent && ( -
- +
+
)} +
+ +
+ {docs.map((doc) => { + const Icon = + iconsMap[doc.slug as keyof typeof iconsMap] ?? FileText; -
    - {docs.map((doc) => ( -
  • - - {doc.title} - -
    • - ))} -
+ const description = + descriptionMap[ + doc.slug as keyof typeof descriptionMap + ]; + + return ( + + +
+ +
+ +
+

+ {doc.title} +

+ + {description && ( +

+ {description} +

+ )} +
+ +
+ +
+ + ); + })}
-
- ) -} + +
+
+) +}; \ No newline at end of file From f19c3bf868ba781350748fa3abdd29c1fd4d8eaf Mon Sep 17 00:00:00 2001 From: rizzhal Date: Fri, 14 Aug 2026 00:11:49 +0530 Subject: [PATCH 2/6] Fix: description --- app/documentation/page.tsx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/app/documentation/page.tsx b/app/documentation/page.tsx index dae5c7d7..26e2ab38 100644 --- a/app/documentation/page.tsx +++ b/app/documentation/page.tsx @@ -17,11 +17,11 @@ const iconsMap = { } as const const descriptionMap = { - "01-printer-application": "Explore how Printer Applications simplify and enhance printing in Linux.", - "02-designing-printer-drivers": "Learn the essentials of building reliable and efficient printer drivers.", - "03-designing-scanner-drivers": "Guidelines and best practices for creating scanner drivers.", - "04-packaging-drivers": "Step-by-step guide to package your drivers and publish to the Snap Store.", - "05-User-Manual": "Comprehensive user manual for Printer Applications.", + "01-printer-application": "Overview of Printer Applications", + "02-designing-printer-drivers": "Creating your first Printer Driver", + "03-designing-scanner-drivers": "Scanner driver architecture and guidelines", + "04-packaging-drivers": "Packaging and publishing drivers", + "05-User-Manual": "Printer Application refernce", } as const export default async function DocumentationPage() { From 6f7fa7062332d450b4c9fc07a8d32ea23cf1f7eb Mon Sep 17 00:00:00 2001 From: rizzhal Date: Fri, 14 Aug 2026 00:34:23 +0530 Subject: [PATCH 3/6] Fix: sentence styles for headings --- contents/documentation/02-designing-printer-drivers.md | 2 +- contents/documentation/03-designing-scanner-drivers.md | 2 +- contents/documentation/04-packaging-drivers.md | 2 +- contents/documentation/05-User-Manual.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/contents/documentation/02-designing-printer-drivers.md b/contents/documentation/02-designing-printer-drivers.md index 153ce0a8..5c600edc 100644 --- a/contents/documentation/02-designing-printer-drivers.md +++ b/contents/documentation/02-designing-printer-drivers.md @@ -1,5 +1,5 @@ --- -title: Designing Printer Drivers +title: Designing printer drivers toc: true toc_sticky: true h_range: [1,2] diff --git a/contents/documentation/03-designing-scanner-drivers.md b/contents/documentation/03-designing-scanner-drivers.md index e700de4b..2ab892b8 100644 --- a/contents/documentation/03-designing-scanner-drivers.md +++ b/contents/documentation/03-designing-scanner-drivers.md @@ -1,5 +1,5 @@ --- -title: Designing Scanner Drivers +title: Designing scanner drivers toc: true toc_sticky: true h_range: [1,3] diff --git a/contents/documentation/04-packaging-drivers.md b/contents/documentation/04-packaging-drivers.md index 128c120d..63fd3f5b 100644 --- a/contents/documentation/04-packaging-drivers.md +++ b/contents/documentation/04-packaging-drivers.md @@ -1,5 +1,5 @@ --- -title: Packaging Drivers and Release them to the Snap Store +title: Packaging drivers and release them to the Snap Store toc: true toc_sticky: true h_range: [1,3] diff --git a/contents/documentation/05-User-Manual.md b/contents/documentation/05-User-Manual.md index db755169..59e8d644 100644 --- a/contents/documentation/05-User-Manual.md +++ b/contents/documentation/05-User-Manual.md @@ -1,5 +1,5 @@ --- -title: User Manual for Printer Applications +title: User manual for Printer Applications toc: true toc_sticky: true h_range: [1,3] From 986011c4d50e79f21a70b17938a34a30e09066d3 Mon Sep 17 00:00:00 2001 From: rizzhal Date: Mon, 17 Aug 2026 11:47:08 +0530 Subject: [PATCH 4/6] Fix: Update the headline and the descriptions --- app/documentation/page.tsx | 10 +++++----- contents/documentation/01-printer-application.md | 2 +- contents/documentation/02-designing-printer-drivers.md | 2 +- contents/documentation/03-designing-scanner-drivers.md | 2 +- contents/documentation/04-packaging-drivers.md | 2 +- contents/documentation/05-User-Manual.md | 2 +- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/app/documentation/page.tsx b/app/documentation/page.tsx index 26e2ab38..764ed11a 100644 --- a/app/documentation/page.tsx +++ b/app/documentation/page.tsx @@ -17,11 +17,11 @@ const iconsMap = { } as const const descriptionMap = { - "01-printer-application": "Overview of Printer Applications", - "02-designing-printer-drivers": "Creating your first Printer Driver", - "03-designing-scanner-drivers": "Scanner driver architecture and guidelines", - "04-packaging-drivers": "Packaging and publishing drivers", - "05-User-Manual": "Printer Application refernce", + "01-printer-application":"Learn how printer Applications work, why they replace traditional CUPS drivers and how they simplify linux printing", + "02-designing-printer-drivers": "Follow a step by step guide to create your first printer driver and understand the fundamentals of printer driver development", + "03-designing-scanner-drivers": "Understand scanner driver architecture, key components and the guidelines for designing and developing scanner drivers.", + "04-packaging-drivers": "Follow the steps to package your drivers and publish them to the Snap Store.", + "05-User-Manual": "Find detailed technical information about Printer/Scanner Applications, including their configuration, installation, components and available options.", } as const export default async function DocumentationPage() { diff --git a/contents/documentation/01-printer-application.md b/contents/documentation/01-printer-application.md index b3d6ab4c..60a8e4f9 100644 --- a/contents/documentation/01-printer-application.md +++ b/contents/documentation/01-printer-application.md @@ -1,5 +1,5 @@ --- -title: Printer Applications - A new way to print in Linux +title: Overview of the printer applications toc: true toc_sticky: true --- diff --git a/contents/documentation/02-designing-printer-drivers.md b/contents/documentation/02-designing-printer-drivers.md index 5c600edc..30278256 100644 --- a/contents/documentation/02-designing-printer-drivers.md +++ b/contents/documentation/02-designing-printer-drivers.md @@ -1,5 +1,5 @@ --- -title: Designing printer drivers +title: Creating Your First Printer Driver toc: true toc_sticky: true h_range: [1,2] diff --git a/contents/documentation/03-designing-scanner-drivers.md b/contents/documentation/03-designing-scanner-drivers.md index 2ab892b8..d85934cd 100644 --- a/contents/documentation/03-designing-scanner-drivers.md +++ b/contents/documentation/03-designing-scanner-drivers.md @@ -1,5 +1,5 @@ --- -title: Designing scanner drivers +title: Scanner driver architecture and guidelines toc: true toc_sticky: true h_range: [1,3] diff --git a/contents/documentation/04-packaging-drivers.md b/contents/documentation/04-packaging-drivers.md index 63fd3f5b..c353ca31 100644 --- a/contents/documentation/04-packaging-drivers.md +++ b/contents/documentation/04-packaging-drivers.md @@ -1,5 +1,5 @@ --- -title: Packaging drivers and release them to the Snap Store +title: Packaging and publishing drivers toc: true toc_sticky: true h_range: [1,3] diff --git a/contents/documentation/05-User-Manual.md b/contents/documentation/05-User-Manual.md index 59e8d644..38c95176 100644 --- a/contents/documentation/05-User-Manual.md +++ b/contents/documentation/05-User-Manual.md @@ -1,5 +1,5 @@ --- -title: User manual for Printer Applications +title: Printer application reference toc: true toc_sticky: true h_range: [1,3] From 1a1970729e778fba64ecd4245b7935d4cfabf2d7 Mon Sep 17 00:00:00 2001 From: rizzhal Date: Mon, 17 Aug 2026 22:00:51 +0530 Subject: [PATCH 5/6] Fix: proper sentence style headings and updated description --- app/documentation/page.tsx | 10 +++++----- contents/documentation/01-printer-application.md | 2 +- contents/documentation/02-designing-printer-drivers.md | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/app/documentation/page.tsx b/app/documentation/page.tsx index 764ed11a..6edb87d1 100644 --- a/app/documentation/page.tsx +++ b/app/documentation/page.tsx @@ -17,11 +17,11 @@ const iconsMap = { } as const const descriptionMap = { - "01-printer-application":"Learn how printer Applications work, why they replace traditional CUPS drivers and how they simplify linux printing", - "02-designing-printer-drivers": "Follow a step by step guide to create your first printer driver and understand the fundamentals of printer driver development", - "03-designing-scanner-drivers": "Understand scanner driver architecture, key components and the guidelines for designing and developing scanner drivers.", - "04-packaging-drivers": "Follow the steps to package your drivers and publish them to the Snap Store.", - "05-User-Manual": "Find detailed technical information about Printer/Scanner Applications, including their configuration, installation, components and available options.", + "01-printer-application":"Learn how printer applications work, why they replace traditional CUPS drivers and how they simplify Linux printing", + "02-designing-printer-drivers": "A step-by-step tutorial to build, run, and test a basic printer driver", + "03-designing-scanner-drivers": "Best practices and key steps for implementing SANE-compatible scanner drivers", + "04-packaging-drivers": "Package your driver as a Snap and publish it to the Snap Store", + "05-User-Manual": "Technical specifications, configuration keys, and command-line options for Printer Applications", } as const export default async function DocumentationPage() { diff --git a/contents/documentation/01-printer-application.md b/contents/documentation/01-printer-application.md index 60a8e4f9..ded7ce85 100644 --- a/contents/documentation/01-printer-application.md +++ b/contents/documentation/01-printer-application.md @@ -1,5 +1,5 @@ --- -title: Overview of the printer applications +title: Overview of printer applications toc: true toc_sticky: true --- diff --git a/contents/documentation/02-designing-printer-drivers.md b/contents/documentation/02-designing-printer-drivers.md index 30278256..83337cc2 100644 --- a/contents/documentation/02-designing-printer-drivers.md +++ b/contents/documentation/02-designing-printer-drivers.md @@ -1,5 +1,5 @@ --- -title: Creating Your First Printer Driver +title: Creating Your first printer Driver toc: true toc_sticky: true h_range: [1,2] From 2563e0d968f672973e5eae3a7464d39b5a5798a3 Mon Sep 17 00:00:00 2001 From: rizzhal Date: Tue, 18 Aug 2026 10:12:07 +0530 Subject: [PATCH 6/6] Fix: remove unnecessary capitalization --- contents/documentation/02-designing-printer-drivers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contents/documentation/02-designing-printer-drivers.md b/contents/documentation/02-designing-printer-drivers.md index 83337cc2..73fc4a01 100644 --- a/contents/documentation/02-designing-printer-drivers.md +++ b/contents/documentation/02-designing-printer-drivers.md @@ -1,5 +1,5 @@ --- -title: Creating Your first printer Driver +title: Creating your first printer driver toc: true toc_sticky: true h_range: [1,2]