Skip to content

Improve documentation page - #228

Merged
tillkamppeter merged 6 commits into
OpenPrinting:masterfrom
rizzhal:ui-improvements
Aug 18, 2026
Merged

Improve documentation page#228
tillkamppeter merged 6 commits into
OpenPrinting:masterfrom
rizzhal:ui-improvements

Conversation

@rizzhal

@rizzhal rizzhal commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

This PR improves the documentation page UI of the official Open Printing website. Earlier when I see page the whole page feels like empty and dull.

What I changed -

  1. Redesigned the documentation page with a cleaner and more consistent layout
  2. Added icons to improve visual representation of documentation sections
  3. Improved documentation cards with better spacing, typography, borders, and hover states
  4. Improved visual hierarchy and readability across the page etc.

@prisorue

prisorue commented Aug 13, 2026

Copy link
Copy Markdown

@rizzhal Amazing work with the icons and the structure of the page! 👏
From my side, the descriptions are reviewed. I've added some suggestions to get ourselves closer to Diataxis.

On the other hand, it's also important to update the headlines so the proposed descriptions fit with the titles; namely:

  • 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 reference

See that I'm suggesting sentence-style for headings, so that proper nouns can be easily identified when mentioned.

@rizzhal

rizzhal commented Aug 13, 2026

Copy link
Copy Markdown
Contributor Author

Thank you @prisorue for your follow up with the suggestions, I am good to go with your suggestions

@rizzhal

rizzhal commented Aug 13, 2026

Copy link
Copy Markdown
Contributor Author

@prisorue fixed with your suggestions

@prisorue

Copy link
Copy Markdown

@rizzhal I built your changes in my local, but I still see the Documentation page as before:

image

I understand that you want to improve the docs page. In this case, my assumption is that:

  • The headings should be updated under contents/documentation/
  • The descriptions should be modified in app/documentation/page.tsx folowing my comments above which are still listed as Pending; example:
image

@rizzhal

rizzhal commented Aug 17, 2026

Copy link
Copy Markdown
Contributor Author
Screenshot from 2026-08-17 11-48-34 @prisorue

@prisorue

Copy link
Copy Markdown

Hello @rizzhal 🌞 . I'm checking the changes. Please allow me some time to properly identify what's going on.

@prisorue prisorue left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent work. I was able to build and view the latest changes. Here you have some final suggestions that deal mostly with capitalization .

Comment thread app/documentation/page.tsx Outdated
} as const

const descriptionMap = {
"01-printer-application": "Explore how Printer Applications simplify and enhance printing in Linux.",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"01-printer-application": "Explore how Printer Applications simplify and enhance printing in Linux.",
"01-printer-application": "Learn how Printer Applications work, why they replace traditional CUPS drivers, and how they simplify Linux printing.",

Comment thread app/documentation/page.tsx Outdated

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.",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"02-designing-printer-drivers": "Learn the essentials of building reliable and efficient printer drivers.",
"02-designing-printer-drivers": "A step-by-step tutorial to build, run, and test a basic printer driver.",

Comment thread app/documentation/page.tsx Outdated
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.",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"03-designing-scanner-drivers": "Guidelines and best practices for creating scanner drivers.",
"03-designing-scanner-drivers": "Best practices and key steps for implementing SANE-compatible scanner drivers.",

Comment thread app/documentation/page.tsx Outdated
"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.",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"04-packaging-drivers": "Step-by-step guide to package your drivers and publish to the Snap Store.",
"04-packaging-drivers": "Package your driver as a Snap and publish it to the Snap Store.",

Comment thread app/documentation/page.tsx Outdated
"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.",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"05-User-Manual": "Comprehensive user manual for Printer Applications.",
"05-User-Manual": "Technical specifications, configuration keys, and command-line options for Printer Applications.",

Comment thread app/documentation/page.tsx Outdated
} as const

const descriptionMap = {
"01-printer-application":"Learn how printer Applications work, why they replace traditional CUPS drivers and how they simplify linux printing",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"01-printer-application":"Learn how printer Applications work, why they replace traditional CUPS drivers and how they simplify linux printing",
"01-printer-application":"Learn how printer applications work, why they replace traditional CUPS drivers and how they simplify Linux printing",

Comment thread app/documentation/page.tsx Outdated

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",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"02-designing-printer-drivers": "Follow a step by step guide to create your first printer driver and understand the fundamentals of printer driver development",
"02-designing-printer-drivers": "A step-by-step tutorial to build, run, and test a basic printer driver",

Comment thread app/documentation/page.tsx Outdated
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.",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"03-designing-scanner-drivers": "Understand scanner driver architecture, key components and the guidelines for designing and developing scanner drivers.",
"03-designing-scanner-drivers": "Best practices and key steps for implementing SANE-compatible scanner drivers",

Comment thread app/documentation/page.tsx Outdated
"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.",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"04-packaging-drivers": "Follow the steps to package your drivers and publish them to the Snap Store.",
"04-packaging-drivers": "Package your driver as a Snap and publish it to the Snap Store",

Comment thread app/documentation/page.tsx Outdated
"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.",

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"05-User-Manual": "Find detailed technical information about Printer/Scanner Applications, including their configuration, installation, components and available options.",
"05-User-Manual": "Technical specifications, configuration keys, and command-line options for Printer Applications",

@prisorue prisorue left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for your hard work! One last change and we're ready.

@@ -1,5 +1,5 @@
---
title: Designing Printer Drivers
title: Creating Your first printer Driver

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
title: Creating Your first printer Driver
title: Creating your first printer driver

@prisorue prisorue left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for the great work. LGTM.

Image

@tillkamppeter
tillkamppeter merged commit 0f0c706 into OpenPrinting:master Aug 18, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants