Giter Site home page Giter Site logo

Comments (6)

stof avatar stof commented on May 23, 2024 1

Well, many packages just use the readme for the doc. But we should encourage them to provide the link to the doc if they have it elsewhere

from recipes-contrib.

stof avatar stof commented on May 23, 2024

Having the documentation link in the config file looks wrong to me: most bundles don't need a config file in the recipe as their default config is fine.

I'm not sure about having a doc link in the recipe. People using flex will never see the recipe file. They will just do composer require acme/awesome-bundle and the recipe file will be used internally by the flex plugin.

So the best place to jave the doc link is still in the Packagist metadata IMO

from recipes-contrib.

Pierstoval avatar Pierstoval commented on May 23, 2024

So we could require the package to have a support.docs entry in the composer.json file, even though it's not largely used atm?
This way, Flex can show the documentation link on each package installation

from recipes-contrib.

chalasr avatar chalasr commented on May 23, 2024

I think the post-install.txt is good enough for giving some hints like a link to a particular documentation.

from recipes-contrib.

stof avatar stof commented on May 23, 2024

And I don't think flex should output the link to the doc of all installed packages. It would be spammy. composer show acme/awesome-bundle will already display it.

from recipes-contrib.

Pierstoval avatar Pierstoval commented on May 23, 2024

Well then I consider it's case closed, if composer & post-install already give the necessary tools for it

from recipes-contrib.

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.