Skip to content

Conversation

@sri-sethu
Copy link
Contributor

@sri-sethu sri-sethu commented Oct 30, 2025

Checklist

Adds a bun add page. Related #19127

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The page(s) follow the style guide.
  • The PR contains at most 5 new pages.
  • The PR is authored by me, or has been human-reviewed if it was created with AI or machine translation software.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known):

Reference issue: #

@github-actions github-actions bot added new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers. labels Oct 30, 2025
@Managor Managor mentioned this pull request Oct 30, 2025
42 tasks
Copy link
Collaborator

@SpikeTheDragon40k SpikeTheDragon40k left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After we solved the issue poited out by Managor, LGTM

@znarfm
Copy link
Collaborator

znarfm commented Oct 30, 2025

shouldn't we have an alias page for bun a?

@Managor
Copy link
Member

Managor commented Oct 31, 2025

I feel like adding an alias page for every shorthand alias would clutter the tab complete suggestions. This would be at least twice as long if every shorthand had its own documentation
image

On the other hand if someone is used to using the shorthands from an online guide and tries to find more info about it, the shorthand would be good for pointing the user to the full page.

I'm torn between these two so I wish to have more opinions on the matter.

@Managor Managor changed the title bun add: add page bun-add: add page Oct 31, 2025
@Managor Managor added the hacktoberfest-accepted PRs that were opened for Hacktoberfest, but may not actually get merged until November. label Oct 31, 2025
@Managor Managor mentioned this pull request Nov 1, 2025
@znarfm
Copy link
Collaborator

znarfm commented Nov 1, 2025

Would it be possible if we track alias pages differently, like maybe a central file like a aliases.json or even a toml, which just maps the original pages into their aliases. If ever, tldr clients can read this single file and display the original tldr page for the alias. But, a big challenge is maintenance since that file would get bigger and bigger over time and it would be messy if not sorted alphabetically.

Another option I can think of is maybe creating a symlink into the original command's tldr page, named as the alias command. Similar to how the pages.en/ directory is just a symlink to pages/, but I don't know if this would work as intended yet.

@Managor
Copy link
Member

Managor commented Nov 4, 2025

We've had previous discussions about auxiliary files and the conclusion was that having the additional complexity wasn't worth it.

Symlinks on the other hand are something that I haven't thought about and I think I haven't seen anyone discuss it. Would you mind opening a an issue on the issue tracker to discuss it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

hacktoberfest-accepted PRs that were opened for Hacktoberfest, but may not actually get merged until November. new command Issues requesting creation of a new page or PRs adding a new page for a command. review needed Prioritized PRs marked for reviews from maintainers.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants