pub-dev
pub-dev copied to clipboard
dart-lang
Customize the Installing tab
It would be useful to be able to add custom instructions to the auto-generated text in the "Installing" tab, or to replace the contents completely.
Goal: provide instructions on how to install pre-compiled native libraries (for a package making use of FFI)
Yes, we've discussed rendering INSTALL.md as the installation tab. I think something like this would be useful.
We also discussed install.md in https://github.com/dart-lang/pub-dev/issues/2125.
As briefly discussed in https://github.com/dart-lang/pub-dev/issues/3008 another option is to remove the "installation" instructions completely.
Arguments for removal is that if installation instructions are important to your package, it's probably best to show them at the top of your README.md as users are unlikely to see them otherwise.
We could probably look at analytics to see if anyone is opening the "installation" tab.
Users of my package, flutter_native_splash, have contacted me with confusion because my readme tells them to add a in dev_dependencies (with is correct), but the installing tab tells them to add in dependencies (which is incorrect). Would be nice to get this fixed!
Users of my package, flutter_native_splash, have contacted me with confusion because my readme tells them to add a in dev_dependencies (with is correct), but the installing tab tells them to add in dependencies (which is incorrect). Would be nice to get this fixed!
I think we should find a way to do: https://github.com/dart-lang/pub-dev/issues/6400 that would at least solve this specifc issue.
Maybe we still need a custom install tab on top of that.
