Shopify / Shopify/roast

Add workflow to validate and update docs & doc comments

Open
#1,008 2 comments 0 reactions 1 assignee View on GitHub

@LasmarKhalifa is already working on this.

Since Jul 3, 2026.

enhancement
Dominant language
Ruby
Stars
1.2k
Forks
76
PR merge metrics
No merged PRs in 30d

Description

To avoid doc drift, we should have a workflow that verifies each doc and each doc comment for correctness and creates PRs for the ones that need modifications.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.