Skip to content

docs: Add change history management interface guide #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
32 changes: 32 additions & 0 deletions docs/core-concepts/managing-changes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Managing Documentation Changes

Promptless provides a comprehensive interface for reviewing and managing suggested documentation changes. This guide explains how to effectively use the change history interface to review, approve, or reject documentation updates.

## Change History Interface

The change history interface shows you all documentation changes suggested by Promptless for a particular trigger (such as a GitHub PR or Slack conversation). For each suggested change, you can:

- View the proposed changes in a diff format
- See the context that led to the suggestion
- Approve or reject individual changes
- Manage multiple changes at once

## Reviewing Changes

Each suggested change shows:

1. The file being modified
2. A diff view highlighting:
- Added content (in green)
- Removed content (in red)
3. The reasoning behind the suggested change
4. Options to approve or reject the change

## Managing Individual Changes

To manage individual changes:

1. Review the proposed changes in the diff view
2. Click "Approve" to accept the changes
3. Click "Reject" to decline the changes
4. (Optional) Provide feedback about why a change was rejected