Skip to content

Auto-generated documentation for release features #1216

@barruka

Description

@barruka

Describe the feature or problem you'd like to solve

Release notes currently list new features with minimal description (e.g., "Add autopilot mode for autonomous task completion"), but lack detailed documentation about what these features are, how they work, how to use them, and best practices.

Proposed solution

Implement automated documentation generation for each release feature, which the team can review/modify before publishing. Ideally, this documentation would auto-publish to a public URL when the release goes live.

Example prompts or workflows

For release 0.0.400 - "Add autopilot mode for autonomous task completion (experimental)"

Auto-generated documentation could include:

  • What it is: Brief explanation of the autopilot mode functionality
  • How it works: Expected behavior and workflow
  • How to invoke it: Command syntax and parameters
  • Usage tips: Best practices, limitations, and common pitfalls
  • Examples: Practical use cases

Workflow:

  1. New feature merged → AI agent generates initial documentation
  2. Team reviews and adjusts the documentation
  3. Release published → Documentation auto-publishes to public URL (e.g., docs.copilot-cli.com/releases/0.0.400)

Additional context

Since copilot-cli is AI-focused, using an AI agent to generate feature documentation seems like a natural fit. This would help users actually adopt new features instead of just knowing they exist. The team maintains control by reviewing/editing before publication, but saves time on the initial documentation draft.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions