# DogsBay XML

> The XML and DITA editor with an AI agent that understands your content model.

## Documentation

- [Home](https://dogsbay.ai/dogsbay-xml-docs.md): An XML and DITA editor with an AI agent that works on your content model and shows you every change before it lands.

## Getting started

- [DogsBay XML overview](https://dogsbay.ai/dogsbay-xml-docs/getting-started/dogsbay-xml-overview.md): What the editor does, who it is for, and the three ideas that shape it.
- [Installing](https://dogsbay.ai/dogsbay-xml-docs/getting-started/install.md): Install DogsBay XML, put its command line on your PATH, and turn on the integration server.
- [Tutorial: Fixing a DITA project by hand](https://dogsbay.ai/dogsbay-xml-docs/getting-started/tutorial-manual.md): Open a DITA project with deliberate errors, find them with the project tools, and fix one by hand.
- [Tutorial: Using an agent to fix a DITA project](https://dogsbay.ai/dogsbay-xml-docs/getting-started/tutorial-agentic.md): Open a DITA project with deliberate errors, find them with the project tools, and fix them with the AI agent.

## Working with the agent

- [The agent, and what it may touch](https://dogsbay.ai/dogsbay-xml-docs/agent/overview.md): Compare built-in and hosted agents, learn which tools they receive, and understand the limits on changes to files.
- [Which agent to use](https://dogsbay.ai/dogsbay-xml-docs/agent/choosing.md): Compare the built-in and hosted agents and learn when to run both.
- [Reviewing an agent's changes](https://dogsbay.ai/dogsbay-xml-docs/agent/proposals.md): Review agent edits to DITA files as tracked changes, and accept, reject, or comment on them.
- [Using Claude Code, Codex, or Gemini](https://dogsbay.ai/dogsbay-xml-docs/agent/hosted-agents.md): Run an agent you already use inside the editor and give it access to the editor's DITA tools.

## Authoring DITA

- [Topics and maps](https://dogsbay.ai/dogsbay-xml-docs/authoring/topics-and-maps.md): Write topics in the source or Author view, assemble them into maps, and edit map structure without breaking references.
- [Keys and reuse](https://dogsbay.ai/dogsbay-xml-docs/authoring/keys-and-reuse.md): Resolve keys across a map, convert direct references to keys, and move shared content into reuse topics.
- [Conditional content](https://dogsbay.ai/dogsbay-xml-docs/authoring/conditional-content.md): Profile content with conditions, filter it with DITAVAL, and keep the values under control with a subject scheme.
- [Metadata](https://dogsbay.ai/dogsbay-xml-docs/authoring/metadata.md): Define required topic metadata, audit the project, and fill in missing fields.

## Finding and changing

- [Validating a project](https://dogsbay.ai/dogsbay-xml-docs/finding/validation.md): Check a document or documentation set against its grammar, business rules, and references. Use the checks as a build gate.
- [Refactoring](https://dogsbay.ai/dogsbay-xml-docs/finding/refactoring.md): Rename, move, split, and restructure content without breaking its references.
- [Mapping a project and writing reports](https://dogsbay.ai/dogsbay-xml-docs/finding/reports.md): See how maps, topics, and keys connect, and write standalone HTML pages that anyone can open.

## Publishing

- [Previewing and publishing](https://dogsbay.ai/dogsbay-xml-docs/publishing/publishing.md): See a styled preview while you write, then build deliverables with DITA-OT.

## Automation

- [Connecting an AI assistant](https://dogsbay.ai/dogsbay-xml-docs/automation/mcp.md): Provide the editor's DITA operations to Claude Code, Claude Desktop, or Cursor over MCP.

## Reference

- [Menu reference](https://dogsbay.ai/dogsbay-xml-docs/reference/menus.md): Find every editor menu and learn what each command does.
- [Panel reference](https://dogsbay.ai/dogsbay-xml-docs/reference/panels.md): Find every panel in the sidebars and bottom bar, and learn what you can do in each panel.
- [Settings reference](https://dogsbay.ai/dogsbay-xml-docs/reference/settings.md): Every page in File > Settings, and what each one controls.
- [Project configuration](https://dogsbay.ai/dogsbay-xml-docs/reference/project-config.md): The files in a project's .dogsbay folder, what each element means, and which ones to commit.
- [Project graph](https://dogsbay.ai/dogsbay-xml-docs/reference/project-graph.md): What the project-graph command returns, field by field, and what counts as a relationship, a shipped file, or an issue.
- [Keyboard shortcuts](https://dogsbay.ai/dogsbay-xml-docs/reference/shortcuts.md): The default key for every command that has one, and how to change it.
- [The command line](https://dogsbay.ai/dogsbay-xml-docs/reference/cli.md): Find the dogsbay-xml command for the information or change that you need.

## For developers

- [Building from source](https://dogsbay.ai/dogsbay-xml-docs/developers/build-from-source.md): Build the editor with Gradle and run the command line from a checkout or an all-in-one JAR file.