Sure, I might actually need a bit of help myself for your first question ;)
What do you mean by: “How is this actually different from normal software documentation distribution besides the standardised location for it?” Could you provide some examples and explain a bit more what you mean by normal software documentation distribution?
Thank you for bringing up the Linux ecosystem. This example is real but notice who ships the docs: the distro maintainers, not upstream. Debian and friends ship man pages in the main package (although some argue that this practice is dying) and the longer prose docs are often split into separate -doc sub-packages, which is the ‘second box’ argued against in the white paper (section 3.5). The upstream artifact usually ships light-weight documentation such as the README.md file and a URL for more thorough documentation.
More importantly, AI coding agents do not usually work against distro packages. They work against npm, PyPI, Maven, crates.io, etc. In most of these ecosystems, the norm is code plus a thin README that points at a website.
The react-query example you mention isn’t quite the exception for complete thorough documentation outside of the installed artifact. We have: docs.rs, Read the Docs (For 2021, Read the Docs reported 700 million page views and 196 million unique visitors - it would be awesome if we had more recent stats but could not find any), GitHub Pages, vendor portals, etc. The README that ships with the package is usually a logo, a one-liner, an install snippet and a link. It’s a pointer, not full documentation inside the installed artifact.
Besides the standardised location, CoDoc is doing a lot more than meets the eye. Location might be the least of it:
A catalog index (index.md) so an agent reads only what’s relevant, within context limits
Version-matching by construction: the registry artifact is immutable, the docs within the installed artifact are there forever
Offline and deterministic: works in air-gapped environments, byte-identical every time
Content designed for the agent: usage guidelines, do/don’t rules, complete runnable examples
Discovery: the agent can expect docs to be there without a human pointing (if the convention gets widespread adoption, it lives in the models’ training data, not in the repo’s config)
The Linux precedent actually supports the CoDoc proposal. The OS world shipped docs in the box because the consumer on the machine needs them locally. CoDoc extends that logic to the language ecosystems, where the consumer on the machine is now increasingly (and I would dare say primarily) an AI agent that reads files.
If the README were enough, Vercel’s evals wouldn’t show 100% vs 53% on APIs absent from training data. The readme didn’t move that number. Complete, version-matched, bundled docs did.
Now, the last two questions:
Why would projects decide to use this method which further bypasses their potential alternative revenue streams or existing documentation?
First, CoDoc does not take the website away. The docs site stays exactly where it is for humans. As a first step, CoDoc can add a generated machine-readable copy inside the artifact, built from the same source of truth (see section 8.7 of the paper). It is additive. react-query keeps its ad revenue stream, your AI coding agent just stops inventing v5 APIs.
Second, the incentive is being chosen as the library for your project. Section 7.3 in the paper discusses the virtuous cycle for libraries that adopt CoDoc: libraries that work well with agents get picked, so maintainers ship docs to stay competitive. This is not hypothetical at all. Design Factory and Next.js now ship their full documentation inside the package, and Vercel’s own evals quoted above are what measured the effect. The TypeScript ecosystem already lived through this transition before. It is best read in Section 12 of the paper. Developers will start asking “does it ship with CoDoc?” the same way they asked “does this library have first-party types?”.
“What poorly documented project is going to adopt this and suddenly write good docs?”
None of them, and CoDoc does not pretend otherwise. CoDoc is a proposed industry standard. Section 8.7 says this out loud under “a note on documentation maturity”. It cannot manufacture documentation that does not exist.
The paper gives libraries an incremental ladder (see section 10.9)
P.S. With your genuinely good questions, you forced me to go back to re-read the paper and do some research. I am now more convinced that CoDoc is the way forward for cheap, fully-local AI-driven development and that there really is a place for CoDoc as a cross-ecosystem standard.
Sure, I might actually need a bit of help myself for your first question ;)
What do you mean by: “How is this actually different from normal software documentation distribution besides the standardised location for it?” Could you provide some examples and explain a bit more what you mean by normal software documentation distribution?
Thank you for bringing up the Linux ecosystem. This example is real but notice who ships the docs: the distro maintainers, not upstream. Debian and friends ship man pages in the main package (although some argue that this practice is dying) and the longer prose docs are often split into separate
-docsub-packages, which is the ‘second box’ argued against in the white paper (section 3.5). The upstream artifact usually ships light-weight documentation such as the README.md file and a URL for more thorough documentation.More importantly, AI coding agents do not usually work against distro packages. They work against npm, PyPI, Maven, crates.io, etc. In most of these ecosystems, the norm is code plus a thin README that points at a website.
The react-query example you mention isn’t quite the exception for complete thorough documentation outside of the installed artifact. We have: docs.rs, Read the Docs (For 2021, Read the Docs reported 700 million page views and 196 million unique visitors - it would be awesome if we had more recent stats but could not find any), GitHub Pages, vendor portals, etc. The README that ships with the package is usually a logo, a one-liner, an install snippet and a link. It’s a pointer, not full documentation inside the installed artifact.
Besides the standardised location, CoDoc is doing a lot more than meets the eye. Location might be the least of it:
index.md) so an agent reads only what’s relevant, within context limitsThe Linux precedent actually supports the CoDoc proposal. The OS world shipped docs in the box because the consumer on the machine needs them locally. CoDoc extends that logic to the language ecosystems, where the consumer on the machine is now increasingly (and I would dare say primarily) an AI agent that reads files.
If the README were enough, Vercel’s evals wouldn’t show 100% vs 53% on APIs absent from training data. The readme didn’t move that number. Complete, version-matched, bundled docs did.
Now, the last two questions:
Why would projects decide to use this method which further bypasses their potential alternative revenue streams or existing documentation?
First, CoDoc does not take the website away. The docs site stays exactly where it is for humans. As a first step, CoDoc can add a generated machine-readable copy inside the artifact, built from the same source of truth (see section 8.7 of the paper). It is additive. react-query keeps its ad revenue stream, your AI coding agent just stops inventing v5 APIs.
Second, the incentive is being chosen as the library for your project. Section 7.3 in the paper discusses the virtuous cycle for libraries that adopt CoDoc: libraries that work well with agents get picked, so maintainers ship docs to stay competitive. This is not hypothetical at all. Design Factory and Next.js now ship their full documentation inside the package, and Vercel’s own evals quoted above are what measured the effect. The TypeScript ecosystem already lived through this transition before. It is best read in Section 12 of the paper. Developers will start asking “does it ship with CoDoc?” the same way they asked “does this library have first-party types?”.
“What poorly documented project is going to adopt this and suddenly write good docs?”
None of them, and CoDoc does not pretend otherwise. CoDoc is a proposed industry standard. Section 8.7 says this out loud under “a note on documentation maturity”. It cannot manufacture documentation that does not exist. The paper gives libraries an incremental ladder (see section 10.9)
P.S. With your genuinely good questions, you forced me to go back to re-read the paper and do some research. I am now more convinced that CoDoc is the way forward for cheap, fully-local AI-driven development and that there really is a place for CoDoc as a cross-ecosystem standard.