Improve documentation page - #228
Conversation
|
@rizzhal Amazing work with the icons and the structure of the page! 👏 On the other hand, it's also important to update the headlines so the proposed descriptions fit with the titles; namely:
See that I'm suggesting sentence-style for headings, so that proper nouns can be easily identified when mentioned. |
|
Thank you @prisorue for your follow up with the suggestions, I am good to go with your suggestions |
|
@prisorue fixed with your suggestions |
|
@rizzhal I built your changes in my local, but I still see the Documentation page as before:
I understand that you want to improve the docs page. In this case, my assumption is that:
|
4c1f01a to
986011c
Compare
|
Hello @rizzhal 🌞 . I'm checking the changes. Please allow me some time to properly identify what's going on. |
prisorue
left a comment
There was a problem hiding this comment.
Excellent work. I was able to build and view the latest changes. Here you have some final suggestions that deal mostly with capitalization .
| } as const | ||
|
|
||
| const descriptionMap = { | ||
| "01-printer-application": "Explore how Printer Applications simplify and enhance printing in Linux.", |
There was a problem hiding this comment.
| "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.", |
|
|
||
| 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.", |
There was a problem hiding this comment.
| "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.", |
| 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.", |
There was a problem hiding this comment.
| "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.", |
| "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.", |
There was a problem hiding this comment.
| "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.", |
| "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.", |
There was a problem hiding this comment.
| "05-User-Manual": "Comprehensive user manual for Printer Applications.", | |
| "05-User-Manual": "Technical specifications, configuration keys, and command-line options for Printer Applications.", |
| } as const | ||
|
|
||
| const descriptionMap = { | ||
| "01-printer-application":"Learn how printer Applications work, why they replace traditional CUPS drivers and how they simplify linux printing", |
There was a problem hiding this comment.
| "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", |
|
|
||
| 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", |
There was a problem hiding this comment.
| "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", |
| 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.", |
There was a problem hiding this comment.
| "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", |
| "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.", |
There was a problem hiding this comment.
| "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", |
| "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.", |
There was a problem hiding this comment.
| "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
left a comment
There was a problem hiding this comment.
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 | |||
There was a problem hiding this comment.
| title: Creating Your first printer Driver | |
| title: Creating your first printer driver |




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 -