Skip to content

For suggested edits, can we show rendered version too and not just the Markdown source? #979

@cellio

Description

@cellio

https://meta.codidact.com/posts/287402
Related: https://meta.codidact.com/posts/294276

It can be hard for reviewers to evaluate suggested edits when Mathjax or other finicky formatting is involved, because the reviewer only sees the Markdown source. Even with the diff pointing out where the changes are, you might not be able to spot a Markdown error. It would be helpful if reviewers could also see the rendered output.

This request is to have a way for a user to switch between viewing the Markdown and viewing the output, keeping the side-by-side presentation (current and proposed edit). In an ideal world we'd show the diff in the output, but that's not strictly necessary so don't worry about it if it's a hassle. We have the diff for the Markdown and that wouldn't change, so that gives the reviewer access to the diff in the source at least.

If we added an option to get the rendered post below the Markdown, then a reviewer could see both in one page. Can we add an expander below the Markdown and above the approve/reject buttons labelled something like "show formatted post", and clicking that would add the side-by-side output? Would that be inefficient (if it has to be generated before the page can load, as opposed to only on demand)? The other approach would be a toggle, so you'd see either Markdown or output but not both, but especially if we can't show the diff in the output, I think it'd be good if a reviewer could see, say, the Mathjax change and its output together.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: frontendChanges to front-end codecomplexity: unassessedNeeds further developer investigation before complexity/feasibility can be determined.priority: medium

    Projects

    Status

    Planned

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions