Skip to content

docs: add InvokeAI Integration user guide page#225

Merged
lstein merged 1 commit intomasterfrom
lstein/docs/invokeai-integration
Apr 26, 2026
Merged

docs: add InvokeAI Integration user guide page#225
lstein merged 1 commit intomasterfrom
lstein/docs/invokeai-integration

Conversation

@lstein
Copy link
Copy Markdown
Owner

@lstein lstein commented Apr 26, 2026

Summary

  • Adds docs/user-guide/invokeai-integration.md, a new User Guide page covering:
    • what InvokeAI is and where to get it
    • creating a PhotoMapAI album from <invokeai-root>/outputs/images/ (with a note about manual re-indexing)
    • configuring the InvokeAI Backend URL in Settings, including optional multi-user credentials and the upload board selector
    • the Recall, Remix, and Use as Ref Image actions in the metadata drawer
    • troubleshooting common URL / auth / cross-machine issues
  • Adds five screenshots under docs/img/.
  • Slots the new page into the User Guide nav in mkdocs.yml.
  • Enables the admonition, pymdownx.details, and pymdownx.superfences markdown extensions so future pages can use boxed notes / collapsible blocks.
  • Drops the explicit --dev-addr=0.0.0.0:8000 from make docs (defaults are fine for the typical workflow).
  • Pins mkdocs<1.6 in the development extras to work around the upstream live-reload regression introduced when mkdocs 1.6 swapped its dev-server backend.
  • Minor copy-edit on docs/index.md (mentions InvokeAI integration in the feature list) and a stale link fix in docs/user-guide/bookmarks.md.

Test plan

  • python -m mkdocs build --clean produces no warnings.
  • make docs serves the site locally and the new page renders correctly with all screenshots and intra-doc links.
  • Browsing to User Guide → InvokeAI Integration in the rendered nav loads the page.
  • Each anchor / cross-link in the page resolves (especially the link to Managing Albums → Indexing Albums and the in-page Troubleshooting anchor).

🤖 Generated with Claude Code

Adds a new User Guide page covering: indexing the InvokeAI outputs/images
folder as an album, configuring the InvokeAI backend URL with optional
multi-user credentials, the Recall / Remix / Use as Ref Image actions in
the metadata drawer, and a troubleshooting section that includes the
cross-machine setup. Also enables the admonition / pymdownx markdown
extensions, drops the explicit --dev-addr from `make docs`, and pins
mkdocs<1.6 to work around the upstream live-reload regression.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@lstein lstein enabled auto-merge (squash) April 26, 2026 15:55
@lstein lstein merged commit 973f1a8 into master Apr 26, 2026
5 checks passed
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