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

"More information" links in alias pages #14542

Open
acuteenvy opened this issue Nov 1, 2024 · 5 comments
Open

"More information" links in alias pages #14542

acuteenvy opened this issue Nov 1, 2024 · 5 comments
Labels
decision A (possibly breaking) decision regarding tldr-pages content, structure, infrastructure, etc. mass changes Changes that affect multiple pages.

Comments

@acuteenvy
Copy link
Member

acuteenvy commented Nov 1, 2024

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

@acuteenvy acuteenvy added decision A (possibly breaking) decision regarding tldr-pages content, structure, infrastructure, etc. mass changes Changes that affect multiple pages. labels Nov 1, 2024
@sebastiaanspeck
Copy link
Member

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

@sbrl
Copy link
Member

sbrl commented Nov 2, 2024

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
Copy link
Member Author

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
Copy link
Collaborator

Managor commented Nov 6, 2024

I'm for removal. Consistency is nice.

@sebastiaanspeck
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
decision A (possibly breaking) decision regarding tldr-pages content, structure, infrastructure, etc. mass changes Changes that affect multiple pages.
Projects
None yet
Development

No branches or pull requests

4 participants