Photo of DeepakNess DeepakNess

We need simpler docs

Unproofread notes

I already had this idea to build a system to create better and simpler online documentation for apps or anything, and this recent Karpathy's tweet validates it. He argues that the primary audience for your docs are now LLMs so you should be optimizing for them, and it does make sense.

PSA It’s a new era of ergonomics.

The primary audience of your thing (product, service, library, …) is now an LLM, not a human.

LLMs don’t like to navigate, they like to scrape. LLMs don’t like to see, they like to read. LLMs don’t like to click, they like to curl.

Etc etc.

My idea is, as also Karpathy explains, have everything in a single .md file and then connect to a tool that neatly creates sidebar hierarchial links based on headings – h2 can be the main navigational links in the sidebar, and clicking on a section should expand also show h3 as sub-links.

The simple idea can be further refined, but the main concept is that there should be a single .md file containing the entire documentation that LLMs as well as humans can easily access without the need to navigate between pages.

For a better experience, the tool can be directly connected to the Git provider like GitHub so that it automatically publishes and processes the updates to the documentation.

I am not yet sure about the tech stacks, but I don't think this would very difficult to implement.

Comment via email