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 💀
The linked documentation doesn't exist anymore. The associated website for the tool [1] shows some useful information, but (IMHO) it's unclear to see how to apply it in a fresh repo. Additionally, `arcanis` mentioned in a comment here [2] that perhaps it should be removed since it's not often used and the playground is broken. Fixes yarnpkg#5837 Fixes yarnpkg#5950 [1] https://github.com/arcanis/sherlock [2] yarnpkg#6139 (comment)
The linked documentation doesn't exist anymore. The associated website for the tool [1] shows some useful information, but (IMHO) it's unclear to see how to apply it in a fresh repo. Additionally, `arcanis` mentioned in a comment here [2] that perhaps it should be removed since it's not often used and the playground is broken. Fixes yarnpkg#5837 Fixes yarnpkg#5950 [1] https://github.com/arcanis/sherlock [2] yarnpkg#6139 (comment)
The linked documentation doesn't exist anymore. The associated website for the tool [1] shows some useful information, but (IMHO) it's unclear to see how to apply it in a fresh repo. Additionally, `arcanis` mentioned in a comment here [2] that perhaps it should be removed since it's not often used and the playground is broken. Fixes #5837 Fixes #5950 [1] https://github.com/arcanis/sherlock [2] #6139 (comment) ## Checklist <!--- Don't worry if you miss something, chores are automatically tested. --> <!--- This checklist exists to help you remember doing the chores when you submit a PR. --> <!--- Put an `x` in all the boxes that apply. --> - [x] I have read the [Contributing Guide](https://yarnpkg.com/advanced/contributing). <!-- See https://yarnpkg.com/advanced/contributing#preparing-your-pr-to-be-released for more details. --> <!-- Check with `yarn version check` and fix with `yarn version check -i` --> - [x] I have set the packages that need to be released for my changes to be effective. <!-- The "Testing chores" workflow validates that your PR follows our guidelines. --> <!-- If it doesn't pass, click on it to see details as to what your PR might be missing. --> - [x] I will check that all automated PR checks pass before the PR gets reviewed.
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