Skip to content

Add the docs-site troubleshooting page - #145

Merged
wallstop merged 1 commit into
mainfrom
t11-troubleshooting-page
Oct 9, 2026
Merged

wallstop merged 1 commit into
mainfrom
t11-troubleshooting-page

Conversation

@wallstop

@wallstop wallstop commented Oct 9, 2026 •

Copy link
Copy Markdown
Owner

The site documented the happy paths; the behaviors that look like bugs but are designed lived only in issues and progress notes. The T11 roadmap item asked for a troubleshooting page. Refs #114.

Behavior

  • docs/troubleshooting.md: async loading and the Loading In Progress refusal, Building search index…, busy-database refresh deferral and postprocessor auto-refresh, missing-script and exact-type listing rules, idle-time selection normalization, the 860x480 and per-pane minimums with preferred-vs-clamped sizes, user-state and settings-asset recovery, and capture regeneration (CLI, output-dir argument/env var, project-root path resolution, meta-free staging, the macOS 6000.4 render-gap limit, container workflow). Every claim traced to main.
  • mkdocs.yml nav gains Troubleshooting after Extending; the index links it under Where to go next.

Validation

Risk / Rollback


Note

Low Risk
Documentation-only; no runtime or package code changes. Risk is outdated or incorrect user guidance, including capture-limit wording tied to #114.

Overview
Adds a Troubleshooting page to the MkDocs site (docs/troubleshooting.md) so “looks broken but is by design” behavior is documented in one place instead of issues/notes. Sections cover gradual async object loading and processor refusal while loading, first-search index build, deferred refresh when the AssetDatabase is busy or Play Mode is active, exact-type and missing-script listing rules, post-recompile selection cleanup, window/pane minimum sizes, corrupt or empty persistence recovery, and how to regenerate docs/images/ via DocsImageCapture (CLI, env var, staging paths, validation, and the macOS 6000.4 capture gap tied to #114), plus a short container/host edit workflow note.

Navigation: mkdocs.yml and Where to go next in docs/index.md link the new page. The diff currently registers Troubleshooting twice in both places (two nav items and two index bullets with slightly different blurbs)—likely an accidental duplicate worth collapsing to a single entry. A Unity .meta companion for the markdown file is also added.

Reviewed by Cursor Bugbot for commit 3be6036. Bugbot is set up for automated code reviews on this repo. Configure here.

The site documented the window's happy paths; the behaviors that look
like bugs but are designed (async loading, search index build, refresh
deferral while Unity is busy, minimum window and pane sizes, corrupt
state recovery) and the capture pipeline's regeneration flow lived only
in issues and progress notes. The roadmap's T11 item asked for a
troubleshooting page. Refs #114.

## Behavior
- docs/troubleshooting.md covers the recorded topics, each traced to
  main: the Loading... counter and Loading In Progress refusal,
  Building search index..., busy-database refresh deferral and
  postprocessor auto-refresh, missing-script and exact-type listing
  rules, idle-time selection normalization, 860x480 / pane minimums
  with preferred-vs-clamped sizes, user-state and settings-asset
  recovery, and capture regeneration (CLI, output-dir argument and env
  var, project-root path resolution, meta-free dot-folder staging, the
  macOS 6000.4 render-gap limit, container workflow).
- mkdocs.yml nav gains Troubleshooting after Extending; the index page
  links it in Where to go next.

## Validation
- mkdocs build --strict green; site/troubleshooting/ published with all
  ten sections, the five PNGs present, and zero .meta files.
- npm run lint:llm green; npm pack payload unchanged (172 files).
@wallstop
wallstop merged commit 87af91f into main Oct 9, 2026
3 checks passed
@wallstop
wallstop deleted the t11-troubleshooting-page branch October 9, 2026 20:53
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