readme for Hackage package servant#1808
Open
peterbecich wants to merge 1 commit intohaskell-servant:masterfrom
Open
readme for Hackage package servant#1808peterbecich wants to merge 1 commit intohaskell-servant:masterfrom
servant#1808peterbecich wants to merge 1 commit intohaskell-servant:masterfrom
Conversation
servant
Contributor
|
@peterbecich Hi, thanks for tackling this. I don't believe the README should contain a list of packages to such an extent. It should say first and foremost:
Remember that this README will then be bundled in the distribution uploaded to Hackage, and cannot be replaced when it gets out of date. I'd rather put down stuff that is hard to bitrot, and have the more volatile kind of documentation live in the Wiki, or in the docs site. :) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Currently https://hackage.haskell.org/package/servant has a short description that points to the tutorial.
The intent of this PR is to add more to this page so that it serves as an overview for the entire Servant project. I think this would be helpful because this package
servanthas the name of the entire project instead of a qualified name i.e.servant-api. https://hackage.haskell.org/package/servant may be the first introduction to servant for some.Perhaps the same list of packages could be added to https://www.servant.dev/ ?
I don't think the Hackage Tag https://hackage.haskell.org/packages/tag/servant is sufficient for this because it includes packages not part of the official project.