←back to thread

28 points eigenvalue | 1 comments | | HN request time: 0.334s | source

I was inspired by a recent tweet by Andrej Karpathy, as well as my own experience copying and pasting a bunch of html docs into Claude yesterday and bemoaning how long-winded and poorly formatted it was.

I’m trying to decide if I should make it into a full-fledged service and completely automate the process of generating the distilled documentation.

Problem is that it would cost a lot in API tokens and wouldn’t generate any revenue (plus it would have to be updated as documentation changes significantly). Maybe Anthropic wants to fund it as a public good? Let me know!

1. rikroots ◴[] No.43371130[source]
Oh! Recently I had the experience of working with someone who was using LLMs to build something using my JS canvas library. The code the LLM was producing for this person was ... sub-optimal. Over-complicated. Not a surprise to me as my library is very niche and the only documentation around it is the docs/lessons I've written myself. So now I'm in the middle of an exercise to write documentation[1] that tries to explains everything (that I can remember) that the library does.

The problem is, I've no idea how useful that documentation would be for LLM consumption - does anyone know of an "Idiot's Guide to writing documentation for LLM consumption" so I can review my work to date and improve the docs going forward?

[1] - In this branch. I'm writing the documentation in .md files which get converted into .html files (using Sundown) during a build step: https://github.com/KaliedaRik/Scrawl-canvas/pull/119/files