Skip to content

Project changes and audit

reference
5 min readUpdated

Use this page to inspect proposed documentation changes, review their details, and read project activity in the audit trail.

Project changes and audit

A project change request is a proposed documentation change that you inspect before it is closed or merged. The project audit trail is the event list for project activity. Use the change request when you need to review proposed content; use the audit trail when you need to inspect recorded project events.

If you need to…Go to
Review a proposed documentation changeReview a documentation change
Inspect conflicts, statuses, or messagesHandle statuses, conflicts, and messages
Read project events or export themReview project audit events
Continue after a merged changeKnow what happens next
Review versionsProject versions
Review audit information elsewhereAudit reference

Before you start

You need access to a project and a reachable project-specific route before you can inspect its changes or audit trail. The changes list uses the signed-in session, and the audit page loads events for the selected project.

These surfaces do not include form fields or required markers. Use the action filter on the project audit page; use the Audit reference page for broader audit guidance.

Find a project change or audit trail

Use the project list to open the project whose documentation changes or activity you need to inspect. The project-specific changes route redirects to the project dashboard's Changes tab. An existing change row opens its detail route.

Prerequisites

  • You have access to a project.
  • You know whether you are looking for a proposed documentation change or an audit event.

Steps

  1. Open the project list.

  2. Choose the project surface that matches your task:

    If you need to…Open
    Review a proposed documentation changeThe project Changes surface
    Inspect project activityThe project Audit Trail
  3. In the Changes surface, select a Change row to open its detail route.

  4. On the detail route, select Back to Changes to return to the Changes surface.

Project list with project rows and their open and delete actions

Result: The selected project Changes surface, change detail route, or Audit Trail is on screen.

Review a documentation change

Use the change request's summary to identify the proposal and its activity entries to follow its history. A diff is the file-by-file view of additions, deletions, sections, hunks, and lines; use it to inspect the affected documentation.

A conflict section places the current text beside the proposed text so you can choose which text to keep.

Prerequisites

  • You have opened a change request from the Changes surface.

Steps

  1. Read the change title, kind, status, commit range, file count, and conflict count in the detail header.

  2. Read the activity entries for Created, Conflicts detected, and Merged when they are present.

  3. Review each affected file in the diff.

  4. Compare the current and proposed text in each conflict section when conflicts are present.

  5. Choose one resolution for each conflict section.

    If you want to…Select
    Keep the current page textKeep mine
    Use the proposed page textUse proposed
    Change the proposed text before applying itEdit inline
  6. Select Apply resolution after choosing a resolution for every section.

  7. Choose the action that matches the proposal:

    If…Select
    The proposal is open and has no conflicts, and you need to inspect the rendered previewOpen preview
    The proposal should not be mergedClose
    The proposal is open and has no conflicts, and it is ready to mergeApprove & merge

Result: The change detail remains on screen with its summary, activity, affected files, diff, and the review controls available for its current status.

Review project audit events

The project audit trail is a chronological event list for project activity. Use it to read the time, actor, action, entity, and details associated with each returned event.

Prerequisites

  • You have opened the project Audit Trail.

Steps

  1. Select an action in All Actions to filter the event list.

  2. Read the Time, Actor, Action, Entity, and Details columns.

  3. Select an audit event row to expand its metadata.

  4. Move through the event pages when the event list has more than one page:

    If you need to…Select
    Return to the previous pagePrevious
    Open the next pageNext
  5. Select Export CSV to request a CSV export of the project audit trail.

Result: The project audit trail shows the selected event view, expanded metadata, page range, or export control.

Handle statuses, conflicts, and messages

The Changes surface groups requests by status, and the detail surface changes its actions when a request is open, conflicted, preparing, merging, merged, or failed. Match the status on screen to its available path.

When the screen shows…The available path is…
OpenOpen preview, Close, and Approve & merge are available when there are no conflicts.
MergedView on Versions is available to continue to the project versions.
ClosedReview these requests in the Closed filter.
A conflictClose, Refresh diff, and conflict-resolution cards are available.
PreparingWait while the branch is being prepared.
MergingWait while the merge is in progress; the Merging control is disabled.
FailedRetry merge is available only when the failure is retryable.

Match each message to the situation that produces it.

SituationMessage
Change-list errorFailed to load change requests
Change-list loadingLoading change requests...
Change-list empty stateWhen your docs are edited, regenerated, or updated by an agent, the proposed changes appear here for review before they land.
Detail loadingLoading change request…
Detail loading errorFailed to load change request
Preview cannot be sharedPublish this project to share a rendered preview of the change.
Preview-link errorFailed to create preview link
Conflict bannerConflicts to resolve — your docs changed since this was proposed. Resolve each section below, then merge.
Conflict choice requiredChoose a resolution for every section
File has no line changesNo line-level changes in this file.
Change has no diffNo diff available for this change request.
Audit export errorExport failed
Audit loadingLoading...
Audit has no eventsNo audit events

Know what happens next

After you finish reviewing a change request, the next destination depends on the action you select. A merged request offers View on Versions. The audit trail remains the place to inspect project events, while the Audit reference page covers audit information more broadly.

After you…Continue to…
Review a merged changeProject versions
Need broader audit guidanceAudit reference
Need the project list againProjects overview
Encounter a general application errorGeneral error messages

Result: You know which follow-on page to open for version review, audit reference information, project navigation, or general error guidance.

Was this page helpful?

Download as PDF
Project changes and audit — Atloria (self dogfood)