Skip to content

docs: add a troubleshooting FAQ for common first-run failures - #358

Draft
tildesrc wants to merge 1 commit into
mainfrom
panopticon/troubleshooting-faq
Draft

docs: add a troubleshooting FAQ for common first-run failures#358
tildesrc wants to merge 1 commit into
mainfrom
panopticon/troubleshooting-faq

Conversation

@tildesrc

@tildesrc tildesrc commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Adds docs/troubleshooting.md, a top-level FAQ for the failures new installs hit most, and links it from the README and docs/overview.md.

Why

Troubleshooting help existed only inside per-topic docs (container.md, hooks.md) — there was no central page for a stuck first-run user to check.

What

docs/troubleshooting.md covers, in FAQ style (question → short answer → link to the owning doc's detail):

  • Quickstart stops at a Claude login / no paid account → use ANTHROPIC_API_KEY
  • GitHub task can't open a PR / gh fails → add GH_TOKEN to the env-file
  • Wanted workflow isn't in the picker → opt-in per repo (g → edit → check)
  • Task stuck at awaiting / never reaches live → Docker daemon + base image; panopticon doctor
  • Services seem gone (tmux ls empty) → the -L panopticon server; panopticon start / console
  • Auth fails / 401 mid-task → re-mint via setup-repo, respawn with R
  • How to read panopticon doctor

Each entry links the owning doc rather than duplicating it. Wired in from the README ("Managing your install") and overview.md ("Where to go next").

Plan: see the task's plan.md artifact.

Add docs/troubleshooting.md, a top-level FAQ covering the failures new
installs hit most: the Claude login/paid-account gate, a missing GH_TOKEN,
a workflow missing from the picker, a task stuck at `awaiting`, services
that seem gone (the -L panopticon tmux server), a mid-task auth 401, and
how to read `panopticon doctor`. Each entry links the owning doc's detail
section rather than duplicating it.

Link it from the README (Managing your install) and overview.md
(Where to go next).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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