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

Formatting standards for the site. #241

Open
Tracked by #221
bph opened this issue Mar 21, 2024 · 5 comments
Open
Tracked by #221

Formatting standards for the site. #241

bph opened this issue Mar 21, 2024 · 5 comments
Assignees

Comments

@bph
Copy link
Collaborator

bph commented Mar 21, 2024

Notes

  • Follow Heading hierarchy on Google Doc comes over well into the Block editor
  • Table of Contents is a pattern found in the Developer Blog category
  • Use the the Notice Alert block or call-outs like special information, warnings.
  • Code Block is in flux right now, don't add a language.
  • Props are right aligned and italics
@bph bph self-assigned this Mar 21, 2024
@bph
Copy link
Collaborator Author

bph commented Apr 4, 2024

Featured image notes:

@ironnysh
Copy link

ironnysh commented Apr 4, 2024

I've just prepared my first post for publication. It went pretty smoothly, but thought I'd share a few suggestions for potential time-savers:

  1. Create a couple of templates for common post types (code-heavy tutorials, What's new, etc.). This way, the ToC and Props section are already there, as well as the Code and Notice blocks.
  2. Provide technical guidelines for social copy and a template for the featured image.
  3. Clarify the external links policy (this post is old and incomplete).
  4. Editor-level users can't see the full tags list, so unless you're covered by the Most used, it's a guessing game.
  5. Make the pre- / post-publishing checklist clickable.
  6. Consider adding the Playground Block to the site ;-)

@bph
Copy link
Collaborator Author

bph commented Apr 5, 2024

All good calls. Thank you @ironnysh

@bph
Copy link
Collaborator Author

bph commented May 16, 2024

  • Add UI references in bold (not quotes) from the Documentation Style Guide
  • How to format links
    <a href="URL">text description phrase, probably title of the post/page titlle</a> for resource lists. inline of the prose
    also use a descriptive phrase don't just use "here" links. please. They are really bad for accessiblity.

@bph
Copy link
Collaborator Author

bph commented Jun 7, 2024

Update on Featured Image:
the design team is working on Thumbnail / Featured image set for the Developer blog in Figma. And then writers can follow the tutorial on how to modify the template for their post.

From the Design share

Generating thumbnail images, a step-by-step video

In collaboration with Kathryn Presner, we recorded a video showing step by step how to generate visuals for WordPress-related videos with the video thumbnail generator file. The file will be public in Figma Community once this video reaches WordPress YouTube channel, but so far, it’s already public on WordPress TV.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants