Voltagent Docs Bundle

Voltagent Docs Bundle

Look up VoltAgent documentation embedded in node_modules/@voltagent/core/docs for version-matched docs. Use for API signatures, guides, and examples

Category: design Source: VoltAgent/skills

What Is This?

Overview

The Voltagent Docs Bundle is a skill that provides direct access to VoltAgent documentation embedded within your local project dependencies. Specifically, it reads from node_modules/@voltagent/core/docs, giving you version-matched documentation that corresponds precisely to the version of VoltAgent installed in your project. This approach eliminates the common problem of consulting online documentation that may describe a different version than what you have installed.

The bundle mirrors the official VoltAgent website documentation and includes additional doc sets covering API signatures, usage guides, and practical examples. Because the documentation lives inside your node_modules directory, it is always synchronized with your installed package version. When you upgrade or downgrade VoltAgent, the embedded docs update automatically alongside the package itself.

This skill is particularly valuable in environments where developers need accurate, offline-accessible reference material. Rather than switching between browser tabs and code editors, developers can query the embedded documentation directly from their tooling, keeping their workflow focused and reducing context switching.

Who Should Use This

  • Developers building AI agent workflows with VoltAgent who need quick API reference lookups without leaving their development environment
  • Teams working in restricted network environments where accessing external documentation websites is limited or unavailable
  • Engineers integrating VoltAgent into larger systems who need to verify exact method signatures and parameter types for the installed version
  • Technical writers and documentation contributors who want to audit what documentation ships with a specific VoltAgent release
  • Developers maintaining multiple projects with different VoltAgent versions who need version-specific reference material for each project
  • AI assistant tools and IDE plugins that need programmatic access to structured VoltAgent documentation for autocomplete and inline help features

Why Use It?

Problems It Solves

  • Version mismatch between online documentation and the installed package causes subtle bugs when API signatures have changed between releases
  • Frequent context switching between the code editor and a browser slows down development and breaks concentration during complex integration work
  • Offline or restricted environments block access to hosted documentation, leaving developers without reference material during critical work sessions
  • Searching through unstructured source code to understand API behavior is time-consuming and error-prone compared to reading dedicated documentation
  • Uncertainty about which features and parameters are available in a specific installed version leads to trial-and-error coding

Core Highlights

  • Documentation is embedded directly in node_modules/@voltagent/core/docs and matches the installed package version exactly
  • Covers API signatures, parameter descriptions, return types, and usage constraints
  • Includes practical guides and annotated examples for common integration patterns
  • Mirrors the official VoltAgent website documentation with additional supplementary doc sets
  • Works fully offline once the package is installed
  • Accessible programmatically by skills, IDE extensions, and AI assistant tools
  • Licensed under MIT, allowing broad use in commercial and open-source projects
  • No separate documentation installation step required beyond the standard package install

How to Use It?

Basic Usage

After installing VoltAgent in your project, the documentation is immediately available at the following path:

node_modules/@voltagent/core/docs

You can list available documentation files with:

ls node_modules/@voltagent/core/docs

To read a specific guide directly from the terminal:

cat node_modules/@voltagent/core/docs/api-reference.md

Specific Scenarios

Scenario 1: Verifying an API signature before use

When you are unsure about the parameters accepted by a VoltAgent method, read the relevant API reference file directly rather than guessing or searching online.

grep -n "createAgent" node_modules/@voltagent/core/docs/api-reference.md

Scenario 2: Reviewing examples for a specific feature

Navigate to the examples directory within the docs bundle to find annotated code samples:

ls node_modules/@voltagent/core/docs/examples
cat node_modules/@voltagent/core/docs/examples/basic-agent.md

Real-World Examples

A developer upgrading from VoltAgent 1.2 to 1.4 can diff the embedded docs between the two installed versions to identify breaking changes before running the updated code. A CI pipeline can parse the embedded API reference to validate that all method calls in the codebase match documented signatures. An IDE plugin can read the docs bundle at startup to populate autocomplete suggestions with accurate, version-specific information.

Important Notes

Requirements

  • Node.js and npm or yarn must be installed to manage the VoltAgent package dependency
  • The @voltagent/core package must be installed in the project for the docs bundle to be present
  • File system read access to the node_modules directory is required for tooling that queries the docs programmatically