search

tldr-pages / tldr

📚 Collaborative cheatsheets for console commands
https://tldr.sh
Other
51.45k stars 4.23k forks source link

"More information" links in alias pages #14542

Open acuteenvy opened 3 weeks ago

acuteenvy commented 3 weeks ago

Some alias pages have them, some do not. There are no documented rules for that.

The style guide is ambiguous, showing one example with the link and one without. https://github.com/tldr-pages/tldr/blob/3eda65e26eb9b4f2bfcc9ee6118af8830fcb7f51/contributing-guides/style-guide.md#aliases

sebastiaanspeck commented 3 weeks ago

I agree. I personally would remove them, since the documentation for the referenced command, has probably the same URL.

sbrl commented 3 weeks ago

It would probably be more consistent to remove more information links from alias pages, especially since alias pages are supposed to just simply 'alias' an alternate name for a command - if the command is different, then copy the page contents instead.

Can anyone dig up anything if there was a reason when alias pages were created for having the more information links on alias pages in the first place?

acuteenvy commented 2 weeks ago

Can anyone dig up anything if there was a reason when alias pages were created for having the more information links on alias pages in the first place?

The relevant part of the style guide was originally created in #7951, but I couldn't find any discussion about it.

Managor commented 2 weeks ago

I'm for removal. Consistency is nice.

sebastiaanspeck commented 2 weeks ago

Can anyone dig up anything if there was a reason when alias pages were created for having the more information links on alias pages in the first place?

The relevant part of the style guide was originally created in #7951, but I couldn't find any discussion about it.

To clarify things in the future, I would suggest removing the link from the first example in the Style Guide.