Job History

What job history is

Job history is the project record of documentation runs. A documentation run is one piece of documentation work; its status tells you whether it is Completed, Failed, Running, Pending, or Cancelled, while its progress, timing, and output are what you review after it starts.

The page is headed Activity & Jobs and groups the project's runs under Recent Jobs. Each run can carry its status, stage information, timestamps, duration, document counts, and failure details. Completed runs can also provide a route to the project's documentation.

Completed summaries can show Documents Created, Documents Updated, Categories Created, Screenshots Captured, and Duration.

Before you start

You need access to a project before you can open its job history. The page uses the project's identifier to load that project's runs, and it is a review surface rather than an editing form.

The page loads the list automatically. If no runs exist, it presents an empty state instead of an editable list. The page does not provide editable fields, Generate Again, screenshot cancellation, or a published-URL action on this surface.

Open a project's job history

Use this procedure when you need to review the runs belonging to a saved project.

Prerequisites

• You are signed in.
• You know the project you want to review.

Steps

1. From the project page, open the project's job history.
2. Read the page heading Activity & Jobs.
3. While the first load is in progress, read "Loading runs…".
4. Select Refresh when you need to reload the list.
5. Select the icon-only Refresh job history control when you are working from the "Recent Jobs" heading.

If the project has no runs, the page shows "No generation runs yet" and "Every documentation generation run for this project lands here."

Result: The project's job list is loaded, or the page shows the empty state for a project with no generation runs.

Read a run's details

A job-history row is a summary of one documentation run. Its status tells you which details and actions are available; its progress and counts tell you how far the work has gone and what it produced.

A completed run shows "Completed" and provides its completion summary. A failed run shows "Failed" and provides failure details. An active run can show "Running" or "Pending"; a cancelled run shows "Cancelled". The completed summary reports "Documents Created" and "Documents Updated". It also reports "Categories Created", "Screenshots Captured", and "Duration".

Use this procedure to inspect a completed or failed run.

Prerequisites

• The project job list is open.
• A completed or failed run is present.

Steps

1. Select the completed or failed job row to expand its details.
2. For a completed run, read "Documentation Generated Successfully!" and "Your documentation has been created and is ready to view". Read Documents Created, Documents Updated, Categories Created, Screenshots Captured, and Duration in the completed summary.
3. For a failed run, read "Job Failed", then read the failure stage and failure text when they are shown.

Result: The selected row shows its available progress, output, completion, or failure details.

Act on a job

The available action depends on the run's status. Use the action that matches the work you need to do, and stop at a confirmation label before submitting a cancellation or deletion.

Prerequisites

• The project job list is open.
• The required status-specific row is present.

Steps

1. Choose one action and, where required, complete its confirmation:

   If you need to…	Select first	Then
   Open the documentation from a completed result	View Documentation	—
   Start cancelling a running or pending job	Cancel	Select Are you sure? only when you intend to submit the cancellation.
   Remove a completed, failed, or cancelled job's generated documents	Delete Job or the displayed Delete <count> Docs action	Select Confirm Delete? only when you intend to remove the generated documents.

Result: A completed result opens View Documentation, an active job reaches its cancellation confirmation, or a terminal job reaches its deletion confirmation.

Choose the right path for the run status

The status is the run's current position in documentation work. Use the status shown on the row to choose what to inspect or do next.

Prerequisites

• The job list is open.
• You can read the status shown on the run row.

Steps

1. Choose the path that matches the status:

   If the row says…	Continue by…
   Completed	Expanding the row to read the completion summary and select View Documentation.
   Failed	Expanding the row to read "Job Failed", the failure stage, and the failure text.
   Running	Reading the progress bar, stage, percentage, and available current-item details; select Cancel if you intend to stop the job.
   Pending	Reading the available progress information; select Cancel if you intend to stop the waiting job.
   Cancelled	Reviewing the available row information and deletion action.
   No rows	Reading "No generation runs yet" and using the project's documentation generation settings to start work.
   A stalled run shown as Failed	Following the Failed path and reading its failure details.

Result: You follow the status-specific path without treating a waiting, active, failed, completed, or cancelled run as another state.

When the history does not load

The page uses different messages for an empty first load and for a refresh that fails while existing rows remain visible. Read the message before deciding whether to reload or continue with the rows already on screen.

The page keeps existing rows visible when a later refresh fails. A stalled run is presented as "Failed" after the inactivity threshold rather than remaining in progress indefinitely.

What to do next

After you review a run, continue according to the result you need.

Prerequisites

• You have read the selected run's status and available details.

Steps

1. Choose the next destination:

   If you need to…	Continue with…
   Open the project's documentation from a completed result	Select View Documentation.
   Return to the current project	Select Back to project.
   Need a status definition	Documentation job status reference
   Need the sequence of generation stages	Documentation generation lifecycle
   Start or monitor operational work	Run documentation work
   Open the wider operations area	Operations overview
   Continue with reader-facing documentation	Published documentation

Result: You are on the documentation, project, lifecycle, status, or operations guidance that matches the result you reviewed.