Skip to content

Update SSH Key Docs: clarify, restore, and improve SSH key generation and agent usage #44216

@cyber-guide

Description

@cyber-guide

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent

What part(s) of the article would you like to see updated?

  1. Fix content errors:
    • Correct typo in "configuration's'" (extra apostrophe).
    • Restore truncated/missing content in several instruction steps.
  2. Restore Troubleshooting information for Windows:
    • Reinstate section on troubleshooting SSH agent conflicts that was included in prior revisions.
  3. Add ssh-add key timeout tip:
    • Document how to use ssh-add -t to configure key expiration in the agent.
  4. Documentation clarity and accuracy:
    • Clarify when to use each key algorithm.
    • Make the documentation more actionable and beginner-friendly.
    • Address version inconsistencies if applicable.
  5. General review for completeness and clarity.

Additional information

  • Issues such as typos and missed steps can confuse new users.
  • Restoring troubleshooting and timeout instructions supports better real-world workflows.
  • Ensures platform-specific guidance is correct for Windows/macOS/Linux.
  • Supports users' security and productivity by making key lifetime/timeout practices easy to follow.
  • Screenshots or walkthrough GIFs would be valuable for visual learners.

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teaminvalidThis issue/PR is invalidtriageDo not begin working on this issue until triaged by the team

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions