Page MenuHomePhabricator

Edit Check: create a way to expose stored check results in read mode
Open, Needs TriagePublic

Description

At present, edit checks only run in the browser inside a VisualEditor edit session. We want to expose suggestions outside edit mode; e.g. on an article in read mode, or on an aggregated list of suggestions. We will need a way to run checks on the server side (T423997) and a storage mechanism to hold these results (T423999). Once we have both, we can create a mechanism to expose the stored check results against the current version of the article, outside a VisualEditor edit session.

Technical considerations

  • The article may have changed since the check result was created. So we need a way to scope the validity lifetime of the result according to the type of check and the nature of the changes.
  • Differences between the VE model and the Parsoid read view should be abstracted away by the storage mechanism of T423999.
  • The mechanism must be lightweight enough to operate in read mode with acceptable performance

Done

  • Stored check results can be exposed in read mode, accessible via an alternative URL scheme or other selection mechanism