Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve pnpm add <git remote URL> documentation #577

Open
MichalBryxi opened this issue Sep 16, 2024 · 0 comments · May be fixed by #578
Open

Improve pnpm add <git remote URL> documentation #577

MichalBryxi opened this issue Sep 16, 2024 · 0 comments · May be fixed by #578

Comments

@MichalBryxi
Copy link

MichalBryxi commented Sep 16, 2024

The problem

I wanted to install a package from a specific commit on my github fork. And I was a biiit confused around the current section of Install from git repository documentation.

I went to a deep(ish) dive through commits and patches/discussions to understand how things are and eventually landing on reading the tests.

The solution

So to prevent future generations needing to go through similar conundrum, I'd propose enhancing said part of documentation to:

  • Create sections to make visual/logical distinction of individual parts.
  • Spell out all major possible syntaxes.
  • Add more explanation to individual parts of the URL like semver: and path:.
  • Copy & paste examples directly from tests so that we're reasonably sure they are correct.
  • Explain defaults.
  • Explain common cases like monorepo & forks.
MichalBryxi added a commit to MichalBryxi/pnpm.io that referenced this issue Sep 16, 2024
- Create sections to make visual/logical distinction of individual parts.
- Spell out all major possible syntaxes.
- Add more explanation to individual parts of the `URL` like `semver:` and `path:`.
- Copy & paste examples directly from [tests](https://github.com/pnpm/pnpm/blob/main/resolving/git-resolver/test/index.ts) so that we're reasonably sure they are correct.
- Explain defaults.
- Explain common cases like monorepo & forks.

Fixes: pnpm#577
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant