Comments (2)
Question: for the long description part, do we want to use the existing Description
field (
performance/docs/Writing-a-module.md
Line 44 in dcbea35
from performance.
@adamsilverstein I think sticking to a brief description in the Description
field would be more in line with how plugins handle this.
Regarding the longer description, I think that's a great idea, but I'm not sure a module header would be suitable for that. What if for example we want multiple sections or any formatting such as bold/italic text etc? Maybe we need another approach here.
I think what would be a neat approach here would be even if we could make the contents of the README.md
for each module actually available in the plugin's settings screen - almost like the readme for wordpress.org plugins can also be viewed in the WordPress Plugins screen. For example:
- Show a little "i" info icon next to each module in the settings screen.
- Clicking that would open a modal.
- The modal would show the full readme content from
README.md
- it would basically need to parse that markdown into HTML, which shouldn't be too much of a stretch using a library.
The above would allow us to show as flexible information in the plugin we could possibly need, and even more importantly it would allow us to keep maintenance low - a single README.md
file would serve for both people looking at the repo and people using the plugin.
If we wanted to include contributor-/developer-specific information in the README.md
files, we could even define a special heading (e.g. ## Development
or ## Contributing
), and then everything after that could be cut off and not be displayed within the plugin.
What do you think?
from performance.
Related Issues (20)
- Prepare 2.1.0 release HOT 1
- Check for each module to only load it if the corresponding standalone plugin is not loaded HOT 1
- Remove any functions, classes, constants etc. from module `load.php` files HOT 1
- Add Server-Timing metric for total load time
- Fix running tests not working unless the repository is cloned to a `performance` directory
- Remove "experimental" flag from Fetchpriority module
- Implement a better architecture for handling module loading
- Add missing sanitization to image editing requests HOT 1
- Include `WordPress-Extra` rules in PHPCS configuration and fix resulting problems
- Support standalone plugins in PL generator meta tag HOT 10
- Add an individual featured image dominant color variable, which can be reused within the page
- Prepare 2.2.0 release HOT 1
- Fix `WordPress-Extra` rules resulting problems for SQLite module HOT 3
- Perform dry run of WebP Uploads release workflow HOT 4
- Improve the UI for manual plugin releases
- "Generate JPEG files in addition to WebP" presents JPG files instead of WEBP HOT 7
- Cannot make dominant color option work HOT 7
- Remove the `@` silencing warnings from PL HOT 2
- Fix standalone plugin publishing script to not attempt re-publishing the same version of a plugin HOT 5
- Enhance the health check message when WebP is not supported
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from performance.