# DocBox

## DocBox

- [Introduction](https://docbox.ortusbooks.com/readme.md): DocBox is a JavaDoc-style documentation generator for your BoxLang and CFML Applications.
- [Release History](https://docbox.ortusbooks.com/readme/release-history.md): A brief history in time of our major releases
- [What's New With 5.0.0](https://docbox.ortusbooks.com/readme/release-history/whats-new-with-5.0.0.md)
- [What's New With 4.1.0](https://docbox.ortusbooks.com/readme/release-history/whats-new-with-4.1.0.md)
- [What's New With 4.0.0](https://docbox.ortusbooks.com/readme/release-history/whats-new-with-4.0.0.md)
- [Contributing](https://docbox.ortusbooks.com/readme/contributing.md): Learn how to contribute to the DocBox project by submitting pull requests, reporting issues, and writing tests.
- [Installation](https://docbox.ortusbooks.com/getting-started/installation.md): Get started with installing DocBox in your BoxLang or CFML application.
- [BoxLang CLI Tool](https://docbox.ortusbooks.com/getting-started/boxlang-cli.md): Get started with the BoxLang CLI tool for generating documentation
- [Configuration](https://docbox.ortusbooks.com/getting-started/configuration.md): Configure DocBox output formats and generation options
- [Annotating Your Code](https://docbox.ortusbooks.com/getting-started/annotating-your-code.md): Learn how to annotate your BoxLang or CFML code for DocBox documentation generation
- [Troubleshooting](https://docbox.ortusbooks.com/getting-started/troubleshooting.md): Common issues and solutions when using DocBox
- [HTML Output](https://docbox.ortusbooks.com/output-formats/html-output.md): Generate browsable HTML documentation for your application Classes
- [JSON Output](https://docbox.ortusbooks.com/output-formats/json-output.md): Generate JSON output for easy documentation imports into other documentation tools and platforms.
- [JSON Schema](https://docbox.ortusbooks.com/output-formats/json-output/json-schema.md): Understanding the output format of the DocBox JSON strategy
- [UML Output](https://docbox.ortusbooks.com/output-formats/uml-output.md): Generate an XML file for graphing your application via Eclipse UML2Tools
- [CommandBox Output](https://docbox.ortusbooks.com/output-formats/commandbox-output.md): Generate CommandBox CLI command documentation with namespace organization
- [Custom Output](https://docbox.ortusbooks.com/output-formats/custom-output-strategy.md): Create your own custom output format by extending DocBox's strategy system.
- [API Reference](https://docbox.ortusbooks.com/advanced/api-reference.md): Complete API reference for DocBox classes and methods


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
This site has an agentic ask interface you may use to query the documentation dynamically by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docbox.ortusbooks.com/index.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
