Documentation

​

Introduction

Documentation sessions are optimized for creating, maintaining, and updating documentation for your project. This specialized workflow focuses on producing clear, concise, and up-to-date documentation that reflects the current state of your codebase.

​

Format

The general format of a documentation session is as follows:

1. Task Definition: You provide the agent with details about the documentation needed, including context and requirements.
2. Analysis: The agent analyzes the provided information and existing documentation to understand the task.
3. Documentation Creation/Update: The agent creates new documentation or updates existing content.
4. Review: You review the generated documentation and provide feedback if necessary.
5. Integration: Once approved, the agent integrates the new or updated documentation into your project.

​

Getting Started

There are two primary ways to initiate a documentation session:

​

GitHub Integration

To start a documentation session through our GitHub integration:

1. Open an issue describing the documentation requirements on GitHub.
2. Comment @honeycombsh document on the issue to begin the process.
   There is no autocomplete for @honeycombsh, so you’ll need to type it out in full.

   Once the agent picks up the issue, it will start working on the documentation.

​

Dashboard

For more control over the session settings, you can initiate a documentation session from the dashboard:

1. Navigate to the Sessions tab.
2. Click on the ‘Begin New’ button.
3. Select the ‘Documentation’ card.
4. Provide the repository, branch, and commit information.
5. Configure setup options as needed.
6. Set a time limit for the session.
7. Provide detailed information about the documentation needed, including any specific requirements or focus areas.
8. Optionally, include a link to the GitHub issue for additional context.