Edit an Existing Guide

Use this workflow when the correct guide already exists and you intend to update it. If you only want to report a problem or request a correction, use Suggest a Change.

Before You Start

Find the guide through the Alarm Lookup, site search, or sidebar.
Check the guide footer and All Open Pull Requests to see whether another PR is already changing it.

New to editing content? Start with the Beginner’s Guide to set up your workspace and work through your first documentation change.

Choose How to Author

With Codex or zdex

If you are new to editing repository content, the Codex workflow can handle the file and Git mechanics while you review and verify the change.

Give the AI assistant the guide URL or file path and the exact requested change. Ask it to read the existing guide first, make the smallest clear edit, preserve unrelated troubleshooting logic and metadata, review the rendered result, and run the required checks.

Start with Author with Codex or Use zdex from Slack.

You remain responsible for verifying that the edit preserves technical truth, safety requirements, and the intended troubleshooting outcomes.

Without Codex

Create a branch from the latest main, open the existing guide in your preferred editor, and make the smallest appropriate change. Use the Author Guide when the edit affects topic structure, troubleshooting flow, outcomes, or applicability.

Preview the rendered guide locally and test every path affected by the edit.

Service Engineering collectively maintains published guides under TW oversight. The author remains responsible for the proposed edit and for taking its PR through review and merge. Consult FSE or Engineering contacts from Technical Contacts by System when expertise is needed; additional technical review is optional when warranted.

Before Review

Review the rendered page and click through every affected path.
Confirm that unrelated metadata, logic, safety wording, and escalation behavior remain unchanged unless the change intentionally updates them.
Complete the Guide content checklist for topic changes.
Run the required checks and open a pull request.
Complete the PR readiness checklist, then use the Guide ownership and workflow to choose the required reviewer and PR status for your role.

Access Required

You need a Zipline GitHub account and write access to ZiplineTeam/service_docs. See Check GitHub Access if you need access.

Open suggestions

There are no open suggestions.

Open pull requests

There are no open pull requests.