Interacting with Doc Holiday

Interacting with Doc Holiday

Doc Holiday automatically runs based on existing workflows and patterns, such as cutting a release, merging code, or the completion of a workflow run. You can also interact with it directly via a chat interface. 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 good doctor understands the following categories of commands:

Note:

  • If the publication input repo is different from the target repo, references to time periods must be made within issues or issue comments in the input repo itself.

  • If a publication is specified by name in chatting with Doc Holiday, the product will honor that publication’s settings to generate release notes, documentation, or both. If it is not specified, the product will generate both release notes and documentation.

  • 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 will create a pull request containing release notes in response to newly created issues, comments on existing issues, comments on existing pull requests or merge requests, and when triggered by releases, workflow runs, or merges.

  • “@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 will create a pull request (or merge request) containing new documentation in response to newly created issues, comments on existing issues, and comments on existing pull requests or merge requests, as well as triggers from 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 input (source) repo is different from the target repo, references to time periods must be made on issues or issue comments in the input repo itself.

Updating Existing Documentation

Doc Holiday will create a pull request (or merge request) containing updates to existing documentation in response to newly created issues, comments on existing issues, comments on existing pull requests or merge requests, and comments in a PR or MR review. Requests can also be triggered by new merges or workflow runs.

  • “@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. Be concise and provide benefit statements”
  • “@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 “integrations” 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”
Getting StartedAPI