Comments (6)
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.
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.
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.
I think the post-install.txt
is good enough for giving some hints like a link to a particular documentation.
from recipes-contrib.
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.
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)
- Bug in automatic merging process? HOT 1
- Post-install for Flysystem v2 gives wrong instructions
- [Sentry Bundle] Clarify config when using monolog HOT 2
- Bref Symfony Bridge recipe HOT 12
- 404 page HOT 1
- SKELETON_VERSION compatibility HOT 1
- IN SF 4.4 Argument 1 passed to FOS\OAuthServerBundle\Entity\ClientManager::__construct() must be an instance of Doctrine\Common\Persistence\ObjectManager HOT 4
- [Idea][Feature request] Allow to setup base project for GHActions / CI verification HOT 2
- Fatal error for mongodb-odm-bundle on Symfony 6 (prod) HOT 1
- recipes-contrib check for PHP 7.4 failing expectedly, preventing merging HOT 3
- Failure on recipe update of friendsofsymfony/ckeditor-bundle
- My library only supports up to 5.4 not symfony6 , and my pull requests always fail when symfony6 checks automatically HOT 5
- New version for sonata page bundle HOT 1
- Process Issue: Contributions are Often Stalled HOT 8
- Rerun failed generation due GitHub was down HOT 1
- The php_codesniffer recipe report errors with the default Symfony installation HOT 1
- PHPStan install instructions reference the wrong name for the included config file
- EUPL as an authorized license HOT 10
- Allow recipes for packages with other type than "symfony-bundle" HOT 3
- Travis build fails for packages with virtual dependency HOT 2
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 recipes-contrib.