Fix Broken Troubleshooting Snippet in ssh-signing.md

[ptr727]

PR #975 (the develop -> main promotion PR) surfaced this against #974's change: the
"signing failed: no allowed signers" troubleshooting line paraphrased the setup
snippet as an unquoted, truncated echo ... >> ... form. Copied literally, a shell
strips the quotes around "git" (writing namespaces=git instead of
namespaces="git"), and the truncated destination path isn't a real command.

Both CodeRabbit and Qodo flagged this independently on PR #975. Fix: use the exact,
complete command from the setup section (matching line 35) instead of paraphrasing it.

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Corrected the SSH signing troubleshooting command to use proper quoting and the complete allowed signers file path.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 6a7eb813-104b-4e71-9c9b-ed4aa3c9363b

📥 Commits

Reviewing files that changed from the base of the PR and between 80fcac2 and bd1346e.

📒 Files selected for processing (1)

• docs/ssh-signing.md

Included review availability: Your plan provides up to 10 included reviews per hour; 6 remain after this review.

---

📝 Walkthrough

Walkthrough

The SSH signing troubleshooting command now uses escaped quoting and the complete allowed_signers path.

Changes

SSH signing documentation

Layer / File(s)	Summary
Correct troubleshooting command docs/ssh-signing.md	The command now quotes the email and namespaces="git" value and appends to ~/.config/git/allowed_signers.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk:⚪ Minimal · up to bd134

This is a narrowly scoped documentation fix that restores the complete, correctly quoted troubleshooting command; no actionable merge-blocking risk remains beyond normal checks and review.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely identifies the main change: fixing the broken troubleshooting snippet in ssh-signing.md.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix-ssh-signing-troubleshooting-snippet

---

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

[qodo-code-review]

PR Summary by Qodo

Fix broken troubleshooting command in ssh-signing.md

📝 Documentation🐞 Bug fix🕐 Less than 5 minutes

AI Description

• Fix the no allowed signers troubleshooting snippet to be copy-paste safe.
• Use the exact, fully quoted command from the setup section.
• Restore the real destination path for allowed_signers.

High-Level Assessment

This is the best approach: reusing the exact setup command avoids paraphrase drift and ensures the snippet remains valid when copied into a shell.

Files changed (1) +1 / -1

Documentation (1) +1 / -1

ssh-signing.mdCorrect allowed_signers troubleshooting command quoting and path+1/-1

Correct allowed_signers troubleshooting command quoting and path

• Replaces a paraphrased/truncated 'echo ... >> ...' troubleshooting snippet with the exact fully quoted command used in the setup instructions. This prevents shells from stripping the 'namespaces="git"' quoting and restores the real destination path ('~/.config/git/allowed_signers').

docs/ssh-signing.md

[qodo-code-review]

Code Review by Qodo

🐞 Bugs (0)📘 Rule violations (0)📜 Skill insights (0)

1. Title ends with lowercase filename✗ Dismissed📘 Rule violation⚙ Maintainability

Description

The PR title ends with ssh-signing.md, which is not Title Case because the final word is not
capitalized. This violates the Title Case requirement for pull request titles.

Code

docs/ssh-signing.md[117]

+**`signing failed: no allowed signers`.** The `allowed_signers` file exists but doesn't contain a line matching `user.email` + a key. Re-run `echo "$(git config --global user.email) namespaces=\"git\" $(cat ~/.ssh/id_ed25519.pub)" >> ~/.config/git/allowed_signers`.

Relevance

●●● Strong

The active repository rule explicitly requires Title Case, and this title visibly ends with
lowercase filename text.

ⓘ Recommendations generated based on similar findings in past PRs

Evidence

PR Compliance ID 2826422 requires Title Case and mandates that the last word of the PR title is
capitalized; the current title ends with ssh-signing.md, which is lowercase.

Rule 2826422: Enforce Title Case for Pull Request Titles with Lowercase Short Bind Words

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution
## Issue description
The PR title is not in Title Case because it ends with the lowercase filename `ssh-signing.md`.
## Issue Context
Compliance requires Title Case for PR titles, with bind words like `in` lowercase when not first/last, and the first/last word capitalized.
## Fix Focus Areas
- docs/ssh-signing.md[117-117]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---

Context sources

✅ Compliance rules (platform): 70 rules

✅ Skills: 5 invoked

comment-and-doc-style

dotnet-codestyle

python-codestyle

shell-codestyle

workflow-ci-contract

Review mode: ⚖️ Balanced

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 ↗