Update README for v2.1 #6110
Update README for v2.1 #6110
Conversation
|
Plugin builds for 3ebc076 are ready 🛎️!
|
|
|
Codecov Report
@@ Coverage Diff @@
## develop #6110 +/- ##
=============================================
+ Coverage 75.03% 75.11% +0.08%
- Complexity 5829 5859 +30
=============================================
Files 232 234 +2
Lines 17618 17713 +95
=============================================
+ Hits 13219 13306 +87
- Misses 4399 4407 +8
Flags with carried forward coverage won't be shown. Click here to find out more.
|
There was a problem hiding this comment.
We also need to update the plugin description:
This official plugin from the AMP project enables AMP content publishing with WordPress in a way that is fully and seamlessly integrated with the standard mechanisms of the platform.
This is what is shown in the directory list:
It appears it needs to be 15 words or less.
Co-authored-by: Weston Ruter <[email protected]>
Co-authored-by: Weston Ruter <[email protected]>
README.md
Outdated
| @@ -2,10 +2,10 @@ | |||
|
|
|||
|  | |||
|
|
|||
| The official AMP Plugin, supported by the AMP team. Formerly Accelerated Mobile Pages, AMP enables great experiences across both mobile and desktop. | |||
| [Page Experience](https://developers.google.com/search/docs/guides/page-experience) (PX) is a set of ranking signals—including [Core Web Vitals](https://web.dev/vitals/#core-web-vitals) (CWV)—measuring the user experience of interacting with a web page. AMP is a powerful and cost-effective tool enabling many optimizations and best practices automatically on your site, and making it easier for you to achieve good page experience. The official AMP Plugin, supported by the AMP team, makes it easy to bring the power of AMP to your WordPress site. | |||
There was a problem hiding this comment.
Unfortunately, according to the WP readme.txt spec, this can be a maximum of 150 characters and it cannot contain links.
In reality, the restriction seems to be even tighter than that. Only the first 15 words are displayed when browsing plugins:
So most of this needs to be moved down under ## Description.
There was a problem hiding this comment.
It could be reduced to just this:
| [Page Experience](https://developers.google.com/search/docs/guides/page-experience) (PX) is a set of ranking signals—including [Core Web Vitals](https://web.dev/vitals/#core-web-vitals) (CWV)—measuring the user experience of interacting with a web page. AMP is a powerful and cost-effective tool enabling many optimizations and best practices automatically on your site, and making it easier for you to achieve good page experience. The official AMP Plugin, supported by the AMP team, makes it easy to bring the power of AMP to your WordPress site. | |
| An easier path to great Page Experience for everyone. Powered by AMP. |
This is 12 words.
There was a problem hiding this comment.
I applied this in 7aac832.
Co-authored-by: Alberto A. Medina <[email protected]>
Summary
With the advent of Page Experience as being the focus of what the AMP plugin delivers, we should update the plugin's metadata to reflect this. In particular, instead of the AMP plugin “The Official AMP Plugin” (which doesn't really say much) we can indicate that it is the “fastest” way to achieve good page experience on a site.
officialwithpage experience, and remove many others)amp.phpFor the tags, only the first 5 are shown:
However, we currently have 11: amp, mobile, optimization, accelerated mobile pages, framework, components, blocks, performance, ux, seo, official.
We can eliminate many of these.
Directory page
Directory Listing
Checklist