Hacker News new | past | comments | ask | show | jobs | submit

Take a look at Traefik, even if you don't use containers

https://j6b72.de/article/why-you-should-take-a-look-at-traefik/
Traefik is pretty cool, but suffers from the same, terrible problem of Ansible: there is a lot of documentation, and a lot of words written, yet you can never find anything you need.

I have used it since v1 and I routinely get lost in their docs, and get immensely frustrated. I have been using Caddy for smaller projects simply because its documentation is not as terrible (though not great by any stretch)

Technical writers: documentation by example is good only for newbies skimming through. People familiar with your product need a reference and exhaustive lists, not explanation for different fields spread over 10 tutorial pages. Focus on those that use the product day in and day out, not solely on the "onboarding" procedure.

This is my pet peeve and the reason why I hate using Ansible so damn much, and Traefik to a lesser extent.

loading story #40266148
loading story #40265883
loading story #40267016
loading story #40272787
Pydantic falls into this box for me. The maintainer refuses to build API reference documentation, as they feel that there should only be one source of information. It's their project, of course, but every time I need to find a method on an object, I am scouring pages of prose for it. Sometimes it's just easier to read the source.
loading story #40274351
loading story #40276081
loading story #40265596
loading story #40274059
loading story #40265675
loading story #40275390
loading story #40266732
loading story #40267329
loading story #40275554
loading story #40272952
loading story #40266476
loading story #40265705
loading story #40273938
loading story #40269898
same reason why Terraform AWS Provider is better documentation than AWS documentation

https://registry.terraform.io/providers/hashicorp/aws/latest...

If I can't find the answer to what I need there I usually resort to LLMs, they are surprisingly good and fetching the info you need out of these massive documentations. The failure rate is quite high though so a lot of trial and error required, but the LLM at least gives you some hints to where to look for it.

My primary use case for LLMs so far has indeed been to avoid terrible technical documentation.
loading story #40274741
loading story #40289138
loading story #40275427
loading story #40275256
loading story #40266882
loading story #40272649
loading story #40270508
loading story #40274561
loading story #40267585
loading story #40266334
loading story #40265918
loading story #40266054
loading story #40265643
loading story #40264932
loading story #40273912
loading story #40265478
loading story #40264726
loading story #40266623
loading story #40264887
loading story #40264846
loading story #40266576
loading story #40265319
loading story #40275045
loading story #40265023
loading story #40266562
loading story #40266192
loading story #40265058
loading story #40273341
loading story #40271185
loading story #40264811
loading story #40265097
loading story #40266327
loading story #40265363
loading story #40272170
loading story #40267222
loading story #40267350
loading story #40268561
loading story #40267950
loading story #40265256
loading story #40265029
loading story #40286850
loading story #40265988
loading story #40272652
loading story #40265770
loading story #40265265
loading story #40264841
loading story #40279425
loading story #40264691
loading story #40265285
loading story #40272352
loading story #40274342