Code Monkey home page Code Monkey logo

Comments (2)

adamsilverstein avatar adamsilverstein commented on July 24, 2024

Question: for the long description part, do we want to use the existing Description field (

* Description: Enhances performance for something.
) or add a new field to the header?

from performance.

felixarntz avatar felixarntz commented on July 24, 2024

@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)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.