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

.: add page #15228

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

.: add page #15228

wants to merge 2 commits into from

Conversation

Managor
Copy link
Collaborator

@Managor Managor commented Dec 19, 2024

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page(s) have at most 8 examples.
  • 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 title conforms to the recommended templates.
  • Version of the command being documented (if known):

@github-actions github-actions bot added the new command Issues requesting creation of a new page or PRs adding a new page for a command. label Dec 19, 2024
@Managor
Copy link
Collaborator Author

Managor commented Dec 19, 2024

I'm super curious if this page breaks anything

@Managor
Copy link
Collaborator Author

Managor commented Dec 19, 2024

#10584

Copy link
Member

@gutjuri gutjuri left a comment

Choose a reason for hiding this comment

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

I'm super curious if this page breaks anything

Have you tested it locally? :P

@Managor
Copy link
Collaborator Author

Managor commented Dec 19, 2024

Seems to work perfectly fine for tealdeer and python tldr client if I place the file in .cache. Not sure how to test the rest of the toolchain.

@gutjuri
Copy link
Member

gutjuri commented Dec 20, 2024

Seems to work perfectly fine for tealdeer and python tldr client if I place the file in .cache. Not sure how to test the rest of the toolchain.

Maybe @sebastiaanspeck knows more since he implemented a large part of it

@sebastiaanspeck
Copy link
Member

I indeed think this would break on Windows. Maybe we can rename it to dot.md? Although that would make it less findable. We could also accept our limitations. Don't know how many times people tried tldr .

@Managor
Copy link
Collaborator Author

Managor commented Dec 26, 2024

dot.md is already taken.

@Managor
Copy link
Collaborator Author

Managor commented Dec 26, 2024

We could create a page like dotsource.md and then use this idea #13908 to create hardcoded redirections.

@sebastiaanspeck
Copy link
Member

We should also add the page title, whatever it is going to be, to the exclusions of scripts/wrong-filename.sh

@acuteenvy
Copy link
Member

I indeed think this would break on Windows.

Why would it break? Multiple dots are allowed in filenames.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page or PRs adding a new page for a command.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants