-
Notifications
You must be signed in to change notification settings - Fork 103
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
Move Optimization Detective docs into README.md #1763
base: trunk
Are you sure you want to change the base?
Conversation
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.
To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
532f0d6
to
dc40b70
Compare
|
Also good to add, although not necessary immediately:
|
Maybe we should add a dedicated |
I thought about a Wiki too, but @joemcgill suggested a README due to it being easier to keep up to date in code (as changes can land with new features in PRs). At the same time, edits are also burdensome since they have to go through the PR process. In any case, I think a README as a landing page makes sense and then we can break out sections into separate docs pages, whether that be in a |
After the most recent release of Optimization Detective, I discovered that the plugin directory has a 2,500 word limit for
readme.txt
files. And Optimization Detective now exceeds the limit:This is resulting in the readme being truncated:
So this PR moves the Background, Technical Foundation, Use Cases/Examples, and Hooks into a
README.md
which is then linked to from thereadme.txt
. The initial two paragraphs of the plugin description are retained in both places for context. Sections are also added for installation, feedback, support, contributing, and security. There is also a new section added for extension plugins.This also further improves the OD-related plugin readmes with a notice that the REST API must be available to unauthenticated visitors. See #1731.