Docs: Missing warning about path_helper
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 25.6k
- Forks
- 941
- Avg merge
- 9h 24m
- Merged PRs (30d)
- 3
Description
### How can we improve the documentation?
In the [Getting Started](https://github.com/asdf-vm/asdf/blob/master/docs/guide/getting-started.md?plain=1#L71) guide there is a note to macOS users to read a warning about `path_helper`:
> macOS users, be sure to read the warning about `path_helper` at the end of this section.
But there is no further mention of `path_helper` on that page. There is, however, a warning about `path_helper` in [the pre-0.16 Getting Started guide](https://github.com/asdf-vm/asdf/blob/master/docs/guide/getting-started-legacy.md?plain=1#L364).
Does this warning still apply?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read docs/guide/getting-started.md at the macOS note and docs/guide/getting-started-legacy.md around the cited warning. Confirm whether the legacy path_helper warning still applies, then make the current guide’s warning and supporting text consistent; done when the current page either contains the applicable warning or no longer points to one.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100