Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readme for Hackage package servant #1808

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

peterbecich
Copy link
Contributor

@peterbecich peterbecich commented Mar 9, 2025

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 servant has 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.

@peterbecich peterbecich changed the title readme for Hackage package https://hackage.haskell.org/package/servant readme for Hackage package servant Mar 9, 2025
@tchoutri
Copy link
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:

  1. What servant is
  2. Point to the tutorials

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. :)

@tchoutri tchoutri self-assigned this Mar 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants