Commenting on and viewing formatted markdown in Pull Request #186730
Replies: 3 comments
-
|
💬 Your Product Feedback Has Been Submitted 🎉 Thank you for taking the time to share your insights with us! Your feedback is invaluable as we build a better GitHub experience for all our users. Here's what you can expect moving forward ⏩
Where to look to see what's shipping 👀
What you can do in the meantime 💻
As a member of the GitHub community, your participation is essential. While we can't promise that every suggestion will be implemented, we want to emphasize that your feedback is instrumental in guiding our decisions and priorities. Thank you once again for your contribution to making GitHub even better! We're grateful for your ongoing support and collaboration in shaping the future of our platform. ⭐ |
Beta Was this translation helpful? Give feedback.
-
|
This would indeed improve the PR review experience, especially as more teams adopt Markdown for documentation and design discussions. A rendered Markdown diff alongside the raw diff would allow reviewers to evaluate formatting, structure, and readability changes directly within the PR, without repeatedly switching to file view. At the same time, keeping the raw Markdown diff available is important for reviewing precise content edits. A possible improvement could be:
This would make documentation reviews much smoother while preserving existing diff workflows for technical reviewers. |
Beta Was this translation helpful? Give feedback.
-
|
Our team uses PRs to review technical design documents (IDFs, impact analyses, architecture plans) stored as markdown. The rich diff toggle exists, which is great for seeing what changed — but we can't leave inline comments on the rendered view. We have to mentally map rendered content back to raw diff lines to comment. For documentation-heavy PRs where the content matters more than the code, being able to read and comment on the rendered markdown directly would make PR-based document review as effective as Confluence or Google Docs, but with the full PR workflow (approvals, CI, history). Our specific workflow: engineers write design docs as The ask: allow inline comments on the rendered (rich diff) markdown view, mapped back to the underlying source lines. |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
Select Topic Area
Product Feedback
Body
We are increasing our use of Markdown files, but the Pull Request files view shows the raw Markdown text. Reviewers would find it easier to review Markdown if they could see and comment on the diff of the formatted Markdown inside the Pull Request without leaving to View File mode. The raw Markdown diff is still valuable, so we should not lose that.
Current Markdown Diff:

Proposed Markdown Rendered Diff:

Beta Was this translation helpful? Give feedback.
All reactions