search

haskell-servant / servant

Servant is a Haskell DSL for describing, serving, querying, mocking, documenting web applications and more!
https://docs.servant.dev/
1.83k stars 413 forks source link

Docs on "Record-based APIs: the nested records case" not in main branch #1701

Open tfc opened 1 year ago

tfc commented 1 year ago

Hello,

i stumbled upon this multiple times:

  1. I need to know how to use record based nested apis, so i go to https://docs.servant.dev (what else?)
  2. It's not there. So i google.
  3. Google leads me to https://docs.servant.dev/en/inserting_doc_namedroutes/cookbook/namedRoutes/NamedRoutes.html

I think this should be merged and part of the normal main docs, or are there reasons against?

ysangkok commented 8 months ago

What makes you think that this is related to git branches? I don't actually know where this is stored or built from, so this is not rhetorical.

tfc commented 8 months ago

I guessed. There is a branch that's called exactly like that version of the docs.

tchoutri commented 8 months ago

Yeah ReadTheDocs does this. We have to bring https://github.com/haskell-servant/servant/pull/1542 to the finish line