Skip to content

docs: move Troubleshooting after the main usage flow, v1.2.1 - #3

Merged
luxsolari merged 1 commit into
mainfrom
docs/troubleshooting-placement
Jul 2, 2026
Merged

docs: move Troubleshooting after the main usage flow, v1.2.1#3
luxsolari merged 1 commit into
mainfrom
docs/troubleshooting-placement

Conversation

@luxsolari

Copy link
Copy Markdown
Owner

Summary

Third fresh-eyes review pass. Troubleshooting sat between Installation and Quickstart, so a first-time reader hit an SSH-permission-denied block immediately after the install commands, before ever seeing the success-path Quickstart. Moved it after Research basis, right before License. Also added a pointer to check the cited upstream issue's current status, since that section pins a specific Claude Code version.

Test plan

  • node --test hooks/lib/__tests__/profile.test.mjs -- 18/18 pass, unaffected (docs-only change)
  • plugin.json validated as well-formed JSON
  • Verified new section order and confirmed no fence-nesting issues introduced

🤖 Generated with Claude Code

Third fresh-eyes pass: Troubleshooting sat between Installation and
Quickstart, so a first-time reader hit an SSH-permission-denied block
with key-generation instructions immediately after the install
commands, before ever seeing the success-path Quickstart -- reading
like "expect this to fail" rather than "here's a fix if it does."
Moved it after Research basis, right before License, matching the
conventional placement (reference/troubleshooting content after the
main usage flow, not embedded inside it).

Also added a pointer to check the cited upstream issue's current
status -- the section pins a specific Claude Code version (v2.1.80)
that may no longer be accurate by the time someone reads this.

Version bumped to 1.2.1.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@luxsolari
luxsolari merged commit 45a0119 into main Jul 2, 2026
1 check passed
@luxsolari
luxsolari deleted the docs/troubleshooting-placement branch July 2, 2026 18:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant