berry icon indicating copy to clipboard operation
berry copied to clipboard

docs: Recover Sherlock documentation

Open BasixKOR opened this issue 2 years ago • 4 comments

What's the problem this PR addresses? The issue template advises to use Sherlock for reproduction but the link is broken.

...

How did you fix it? Recover the Sherlock documentation from website branch. ...

Checklist

  • [x] I have set the packages that need to be released for my changes to be effective.
  • [x] I will check that all automated PR checks pass before the PR gets reviewed.

BasixKOR avatar Feb 23 '24 08:02 BasixKOR

I wonder if perhaps we shouldn't just remove Sherlock altogether. We don't use it much, and its playground is often broken 😞

arcanis avatar Mar 04 '24 19:03 arcanis

As far as I understand, the playground was essentially just an API (+ Next.js app?) hosted on CodeSandbox? What makes it difficult to maintain? What eventually completely broke it?

I think sherlock and the playground is important unless/until the contributors have enough bandwidth to triage issues/bug reports.

clemyan avatar Mar 05 '24 02:03 clemyan

Per my last experience with Sherlock, the problem was often more of 'How can move this reproduction to Sherlock?' rather than reproduction itself, so I think the issue could be potentially resolved with better documentation on how to use Sherlock. I assume this discussion would fit better on the dedicated thread on Discussions tab?

BasixKOR avatar Mar 05 '24 02:03 BasixKOR

UX is definitely important for both sherlock and the playground, but I want to get the playground back up first to at least have something. I can get a PoC working on CodeSandbox but that seems like the same architecture as the old playground, so I'd like the maintainers' input on the pitfalls of maintaining the old playground before continuing.

clemyan avatar Mar 11 '24 03:03 clemyan