Package-embedded agent documentation places current Markdown, usage guidance, or machine instructions beside the library code that an agent inspects. This makes the documentation available in local repository context and ties it more closely to the exact package version used by the project.
Bundled documentation should remain concise and avoid inflating packages with unnecessary copies. Release tooling should update it with the code, verify links and examples, and distinguish generated reference material from hand-curated instructions. Sensitive internal information and credentials must never be included.
Acronyms and aliases
package-local AI documentation acronymbundled agent documentation synonym
General terms
Related terms
Frequently asked questions
Why bundle agent documentation inside a software package?
Coding agents frequently inspect installed packages, so bundled guidance is easier to find and more likely to match the exact installed version.
What format works for package-embedded agent documentation?
Compact Markdown with clear headings, stable local references, version-relevant examples, and explicit project instructions is commonly suitable.
