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 help example #15981

Merged
merged 78 commits into from
Mar 25, 2025
Merged

*: add help example #15981

merged 78 commits into from
Mar 25, 2025

Conversation

Managor
Copy link
Collaborator

@Managor Managor commented Mar 18, 2025

  • 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):

@Managor Managor requested a review from cyqsimon as a code owner March 18, 2025 19:15
@github-actions github-actions bot added mass changes Changes that affect multiple pages. page edit Changes to an existing page(s). labels Mar 18, 2025
@sebastiaanspeck
Copy link
Member

What is the added value for adding this in so many pages? I see adding help purely as page-fillers if there are only two or three descriptions.

@Managor
Copy link
Collaborator Author

Managor commented Mar 19, 2025

Many of these pages were created by me as a barebones starting point. Since these pages don't fully document the commands, it's best to direct the user somewhere where they can find the info themselves. I checked all of them and if the command had more to it than what was documented in the tldr page, I added the help command. There were a couple pages where the command was fully documented so I added nothing.

As you can see, I deleted nothing to add these.

Copy link
Member

@MachiavelliII MachiavelliII left a comment

Choose a reason for hiding this comment

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

Huge respect for your efforts!

@Managor Managor merged commit 67dad77 into tldr-pages:main Mar 25, 2025
3 checks passed
@Managor Managor deleted the help branch March 25, 2025 22:36
marcos-aparicio pushed a commit to marcos-aparicio/tldr that referenced this pull request Mar 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
mass changes Changes that affect multiple pages. page edit Changes to an existing page(s).
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants