Suggest edits in the visual editor

Workflows•4 min read|||

Use this workflow when you want to propose exact wording changes instead of describing them in a comment.

Before you start

  • Open the target PR in DraftView.
  • Confirm you have edit permission on that queue item.

Steps

Use the file list to move to the section you want to edit.

Edit directly in the rendered content. Keep each change focused so authors can apply it quickly.

Open the submit panel and review the chunks DraftView prepared.

Submit your review. DraftView posts suggestions and comments to the PR.

What happens on submit

  • GitHub-linked reviewers post directly to GitHub.
  • Magic-link reviewers create pending team feedback.
  • A GitHub-linked teammate can verify and push pending feedback.

Work with images

  • Images render inline in the editor, including images referenced by relative paths in the repository. Images that the PR adds also preview correctly.
  • Select an image to edit its source, alt text, and title, or to remove it.
  • Use the Insert image button in the toolbar to add a new image.
  • DraftView never rewrites stored image paths. Your edits submit with the original path style.

Notes for AsciiDoc and includes

DraftView preserves source format on submit. AsciiDoc edits remain AsciiDoc. If a file includes other files, open and edit each included file directly.

Related pages