Getting Started

Setting up Doc Holiday is the proverbial piece of cake!

1. Install Doc Holiday

GitHub, GitLab, and Bitbucket all supported! Install the provider for GitHub or Bitbucket, and then go to the Connections page in Doc Holiday to add code repos as sources. Note: GitLab requires only a source.

2. Define Connections

• Set up connections for each piece of upstream information you want Doc Holiday to use when writing words. If code and documentation live in the same repository, then only one connection is required.

3. Define Publications

• Add at least one Publication to specify which connections will be read from (inputs) and which will be written to (targets).

• For each Publication, configure:

  • Name: Internal reference for your Publication

  • Source(s): Connections containing relevant source information

  • Target(s): Connections for documentation and release notes output

  • Style Guide (optional but highly recommended): Link to a public URL, Google Drive, or Notion style guide

  • React To: Select activities that should trigger Doc Holiday to write (e.g., Pull Requests, Issues, Issue Comments, Releases, Workflow Runs)

  • Write: Specify what kind of output to generate (Documentation or Release Notes)

4. Let's Ride!

Doc Holiday will now generate and update release notes and documentation automatically based on your Publications and selected reaction triggers. To interact directly, mention @doc.holiday in issues, pull requests, or release events — Doc Holiday will do the rest!

Enjoy effortless and world-class documentation and release notes with Doc Holiday! 🚀