Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better print stylesheets for PHP Documentation Standards page #1521

Open
flexseth opened this issue Mar 28, 2024 · 4 comments
Open

Better print stylesheets for PHP Documentation Standards page #1521

flexseth opened this issue Mar 28, 2024 · 4 comments
Assignees
Labels
developer documentation (DevHub) Improvements or additions to developer documentation self-assigned [Status] To do Issue marked as Todo

Comments

@flexseth
Copy link
Collaborator

flexseth commented Mar 28, 2024

Issue Description

The top part of the page (when printed) overlaps the coding standards documentation. For those of us who print stuff, it's helpful to have a clean look. This document is specifically helpful because it has a bunch of really helpful reference information - 13 pages of reference about documenting:

  • Functions and classes
  • Requires and includes
  • Hooks
  • Inline comments
  • FIle headers
  • Constants

In a way that other parts of the WordPress documentation can consume this information (PHP Doc Blocks)
Also is important when submitting your software for review to be listed on WordPress.org

URL of the Page with the Issue

PHP Documentation Standards

Section of Page with the issue

Every page header when printed - the following is unnecessary on a printout:

  • Document head
  • Responsive menu displays on printed page
  • Breadcrumbs
  • Back to top link

Why is this a problem?

Makes the text illegible at the top of every printed page (13). This makes about 10% of every page unreadable when printed.

Suggested Fix

Add a print stylesheet or update styles for these sections on the existing print stylesheet

@flexseth flexseth added developer documentation (DevHub) Improvements or additions to developer documentation [Status] To do Issue marked as Todo labels Mar 28, 2024
Copy link

Heads up @WordPress/docs-issues-coordinators, we have a new issue open. Time to use 'em labels.

@flexseth
Copy link
Collaborator Author

/assign

Copy link

Hey @flexseth, thanks for your interest in this issue! 🍪🍪🍪
If you have any questions, do not hesitate to ask them in our #docs Slack channel.
Enjoy and happy contributing ❤️

@flexseth
Copy link
Collaborator Author

To view how it looks when printed, go to the PHP Coding Standards as linked above, and try to print the page.

Should see extra stuff that doesn't need to be there in the page header. It cuts off important documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer documentation (DevHub) Improvements or additions to developer documentation self-assigned [Status] To do Issue marked as Todo
1 participant