πŸ’Ž PREMIUM: WordPress/performance/pull/ - Complete Album!

Skip to content

Conversation

@felixarntz

This PR adds a /docs folder with an initial article detailing the module specification, with minimum requirements and recommendations for writing a module for the performance plugin.

The documentation includes a minimal demo module file, as clarification and a potential starting point for any module.

« Prev

Fixes #2

@ThierryA

LGTM.

ThierryA
@felixarntz felixarntz mentioned this pull request Dec 2, 2021
@JustinyAhin JustinyAhin self-requested a review December 2, 2021 07:54
JustinyAhin

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good docs. It looks fine for me.

aristath
adamsilverstein

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

πŸ‘πŸΌ Nice work!

tillkruss
@tillkruss

Should the notices be dismissible?

@felixarntz

@tillkruss That notice is only a random code example, just to have any code in the demo module. For example if you just start your module with that file, seeing that notice will tell you that you did things right. :)

So it doesn't really matter, our actual modules probably shouldn't contain admin notices in the first place.

@felixarntz felixarntz merged commit fd8a2a6 into trunk Dec 2, 2021
@felixarntz felixarntz added [Type] Documentation Documentation to be added or enhanced Infrastructure Issues for the overall performance plugin infrastructure labels Dec 6, 2021
@felixarntz felixarntz added this to the Initial plugin release milestone Dec 6, 2021
@felixarntz felixarntz changed the title Add module specification in documentation Define module specification in documentation Dec 6, 2021
@tillkruss tillkruss deleted the add/2-writing-a-module-docs branch March 7, 2022 19:27
@gerardv gerardv mentioned this pull request Feb 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Infrastructure Issues for the overall performance plugin infrastructure [Type] Documentation Documentation to be added or enhanced

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Define basic module specification

7 participants