Fix ssh-signing.md allowed_signers Snippet to Match host-setup.md

[ptr727]

Applies the same fix PR #708 made in docs/host-setup.md to docs/ssh-signing.md, which carried the identical bugs:

1. Missing --global on git config user.email, which silently writes the wrong principal into allowed_signers when run from inside an existing repo checkout with a local override.
2. A backslash line-continuation across two lines, collapsed into one, matching the fixed shape in docs/host-setup.md.

Also fixes the identical inline reference to the same snippet in the Troubleshooting section.

Fixes #713

🤖 Generated with Claude Code

[coderabbitai]

Warning

Review limit reached

Next included review available in 2 minutes.

View limit details

Limit details: You’ve used all 10 included reviews currently available.

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 65a5e7b0-2115-44a7-b21e-d389a1d763d8

📥 Commits

Reviewing files that changed from the base of the PR and between 11c7787 and 1e96655.

📒 Files selected for processing (1)

• docs/ssh-signing.md

---

_{Comment @coderabbitai help to get the list of available commands.}

[qodo-code-review]

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Tip of the day

💡 Did you know, you can switch off images and animations for a plain-text comment

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

[qodo-code-review]

PR Summary by Qodo

Align ssh-signing.md allowed_signers snippet with host-setup.md

📝 Documentation 🐞 Bug fix 🕐 Less than 10 minutes

AI Description

• Fix allowed_signers snippet to read user.email from global git config.
• Remove fragile line-continuation so the echo appends correctly as a single line.
• Update troubleshooting snippet reference to match the corrected command.

Diagram

graph TD
  U((Developer)) --> D["docs/ssh-signing.md"] --> C["Run allowed_signers snippet"] --> A["~/.config/git/allowed_signers"] --> G["Git SSH signing"]

Loading

High-Level Assessment

The following are alternative approaches to this PR:

1. Deduplicate snippet via shared include/partial

• ➕ Prevents host-setup and ssh-signing docs from drifting again
• ➕ Enables single-point fixes for future corrections
• ➖ Requires docs tooling/support for includes (or a build step)
• ➖ Adds indirection when reading docs on GitHub

2. Link to host-setup snippet instead of duplicating it

• ➕ Simple; avoids repeated command text across docs
• ➕ Keeps the authoritative snippet in one place
• ➖ Readers must context-switch to another doc
• ➖ May be less discoverable for users who only read ssh-signing.md

3. Add a docs check to catch `git config user.email` (missing --global) in snippets

• ➕ Automated guardrail against reintroducing the same mistake
• ➕ Scales to other common snippet footguns
• ➖ Extra CI/lint maintenance
• ➖ Potential false positives in unrelated documentation contexts

Recommendation: The PR’s direct fix is appropriate and low-risk. As a follow-up, consider deduplicating or linking the snippet to reduce future drift; adding a lightweight docs lint for known-bad patterns could further prevent recurrence.

Files changed (1) +2 / -3

Documentation (1) +2 / -3

ssh-signing.mdFix allowed_signers snippet to use global user.email and single-line echo +2/-3

Fix allowed_signers snippet to use global user.email and single-line echo

• Updates the setup snippet to use 'git config --global user.email' to avoid repo-local overrides producing an incorrect principal. Collapses the backslash-continued 'echo' into a single line, and updates the troubleshooting reference to match.

docs/ssh-signing.md