Skip to content
Zipline Zipline Service Documentation

    Reviewer Guide

    This track is for people reviewing pull requests in service_docs. It separates two jobs that are easy to blur together:

    • Understand the PR workflow, PR statuses, and reviewer actions.
    • Review the PR in GitHub and the rendered site preview.

    How to use this training

    Section titled “How to use this training”

    For the shared responsibilities and Who owns what table, see Guide ownership and workflow. New-guide PRs are completed by the assigned FSE; existing-guide edits stay with the author. Required reviews remain TW/SE2.

    Start with PR workflow to understand the required review order, labels, and PR statuses.

    1. Review and approve PRs - follow the role-specific reviewer actions and handoffs.
    2. How to review a PR - follow the click-by-click GitHub review workflow.

    For a quick reminder of what to check in a guide, use the PR review checklist.

    Appendix: Use review comment boxes - leave plain comments, Markdown notes, and GitHub suggestions from the Files changed view.

    Use these pages together. The PR workflow defines the shared review order, labels, and statuses; the review-and-approve page explains reviewer actions and handoffs; the how-to page walks through the GitHub and preview steps; and the appendix shows how to write useful line comments and direct code change suggestions.