docs: Recover Sherlock documentation #6139
Conversation
BasixKOR
changed the title
| slug: /advanced/sherlock | ||
| title: "Sherlock" | ||
| description: An overview of Yarn's GitHub Actions issue toolkit that helps users provide minimal reproductions. | ||
| hidden: true |
There was a problem hiding this comment.
I'm not sure if the hidden flag does work on newer Docusarus-based website but I don't think it should be a dealbreaker.
|
I wonder if perhaps we shouldn't just remove Sherlock altogether. We don't use it much, and its playground is often broken 😞 |
|
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. |
|
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? |
|
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. |
|
|
||
| ## Developing your reproduction | ||
|
|
||
| The easiest and most convenient way to develop your reproduction is by using the [Playground](/playground) (powered by [CodeSandbox](https://codesandbox.io/)). |
There was a problem hiding this comment.
BTW: This link is also dead 💀
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
websitebranch....
Checklist