> For the complete documentation index, see [llms.txt](https://sandgarden.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sandgarden.gitbook.io/docs/interactions.md).

# Interacting with Doc Holiday

Doc Holiday responds when a request starts in a Source, in a pull request or merge request, in a release, in a workflow run, or directly in the Admin UI. The chat interface and the **Create Work** button provide direct entry points. Completed work appears in [Work History](/docs/work-history.md), and trigger settings live in [Publications](/docs/publications.md).

Doc Holiday responds to `@doc.holiday` within new issues and issue comments, pull requests or merge requests, and releases across supported providers (GitHub, GitLab, and Linear for issues and comments). The following request types cover the most common ways to ask for work:

> **Note:**
>
> * If a Publication reads from one Source and writes to another, time periods must appear in issues or issue comments in the input Source itself.
> * If a Publication is selected by name in chat, Doc Holiday uses that Publication's settings to generate release notes, documentation, or both. If no Publication is selected, Doc Holiday generates release notes, documentation, and a changelog.
> * Use `@doc.holiday` only. Other names are not recognized.
> * The requests "this file" and "this PR/MR" only work in a PR or merge request comment. In the case of exactly one changed file, "this file" will work; otherwise, specify a file path.

### Creating Release Notes

Doc Holiday creates a pull request containing release notes when a new issue, an issue comment, a pull request or merge request comment, a release, a workflow run, or a merge asks for one.

If the changes do not include anything worth highlighting, Doc Holiday says that no documentable changes were found instead of forcing release notes.

* "@doc.holiday write release notes about the new feature developed in /mono/analysis/time\_series/"
* "@doc.holiday create release notes covering the last 20 commits"
* "@doc.holiday make release notes addressing all commits from 2a364710beefcff2bbd6c230a54596932141101a to 119210238c548e4bc97fa053e56292edf8e45299"
* "@doc.holiday generate release notes for changes over the last two weeks"
* "@doc.holiday generate release notes for this PR"
* "@doc.holiday generate release notes for this merge request"
* "@doc.holiday generate release notes for Publication xyz"
* "@doc.holiday generate release notes for MR !456 in group/project"

### Creating New Documentation

Doc Holiday creates a pull request or merge request containing new documentation in response to new issues, issue comments, pull request or merge request comments, new releases, workflow runs, and merges.

* "@doc.holiday create new documentation about the new feature developed in /mono/analysis/time\_series/"
* "@doc.holiday add a document to this PR about how the new methods of authentication work"
* "@doc.holiday add a document to this merge request explaining the new authentication methods"
* "@doc.holiday write new documentation for commits between 2a364710beefcff2bbd6c230a54596932141101a and 119210238c548e4bc97fa053e56292edf8e45299"
* "@doc.holiday make new documentation about functionality contained in the last week or code changes"
* "@doc.holiday generate documentation for Publication xyz"

Please note: if the Publication reads from one Source and writes to another, references to time periods must be made on issues or issue comments in the input Source itself.

### Updating Existing Documentation

Doc Holiday creates a pull request or merge request with targeted edits to existing documentation when a new issue, issue comment, pull request or merge request comment, review comment, merge, or workflow run asks for updates. It updates only the requested parts of a document and leaves unrelated sections unchanged.

* "@doc.holiday update the documentation about supported databases to include our new support for Postgres"
* "@doc.holiday rewrite the contents of this PR in the voice of a product marketing manager who is speaking to a non-technical audience. Keep unrelated sections intact"
* "@doc.holiday update the documentation on account setup to reflect changes in the last 20 commits"
* "@doc.holiday revise the /mono/docs/getting\_started.md document to exclude any mention of configuring Kubernetes"
* "@doc.holiday replace all mentions of "connections" with "Sources" throughout all the documentation"
* "@doc.holiday please revert the most recent change"
  * PR or MR comments only
* "@doc.holiday delete the /mono/docs/deprecated.md file"
* "@doc.holiday move the /mono/drafts/user.md file to the /mono/docs/ directory"