# Fix links and commands in the documentation that no longer work

Links that 404 and commands that error, fixed after each one is actually exercised.

Category: Documentation and knowledge
Source: https://letsship.ai/use-cases/fix-broken-links-and-commands
Published: 2026-08-25

## Goal

Fix broken links and non-working commands in the documentation.

## Acceptance criteria

- Every link resolves
- Every command is run and its output matches what the documentation claims
- Commands that need credentials are marked as such rather than silently failing
- A link check runs on a schedule afterwards

## What lands as proof

Evidence that each command was run, not just read, since a command that errors is worse than no command.

## Prompt

Copy this to an agent to open the ticket:

```text
Create a Linear issue in my team and assign it to the SHIP agent.

Title: Fix the broken links and commands in {docs}

Description: Fix broken links and non-working commands in the documentation.

Acceptance criteria:
- Every link resolves
- Every command is run and its output matches what the documentation claims
- Commands that need credentials are marked as such rather than silently failing
- A link check runs on a schedule afterwards

Before you create the issue, run a link check over this repository's documentation and try its commands. Replace {docs}.
```

## Questions

### What does the agent actually change?

The ticket is scoped to one outcome: fix broken links and non-working commands in the documentation. Work that serves that outcome is in scope, and anything outside it is left for a separate ticket, so the pull request stays reviewable.

### How do I know the work is done?

The pull request carries the evidence, not only the diff. Here that means each link and each command exercised in the pull request, so a reviewer can confirm the result without reproducing the work locally.

### How much oversight does this need?

None is required before the run starts. Every claim this ticket makes can be checked by machine, so the agent works straight through and a person reviews the finished pull request like any other.