docs: add InvokeAI Integration user guide page#225
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/user-guide/invokeai-integration.md, a new User Guide page covering:<invokeai-root>/outputs/images/(with a note about manual re-indexing)docs/img/.mkdocs.yml.admonition,pymdownx.details, andpymdownx.superfencesmarkdown extensions so future pages can use boxed notes / collapsible blocks.--dev-addr=0.0.0.0:8000frommake docs(defaults are fine for the typical workflow).mkdocs<1.6in thedevelopmentextras to work around the upstream live-reload regression introduced when mkdocs 1.6 swapped its dev-server backend.docs/index.md(mentions InvokeAI integration in the feature list) and a stale link fix indocs/user-guide/bookmarks.md.Test plan
python -m mkdocs build --cleanproduces no warnings.make docsserves the site locally and the new page renders correctly with all screenshots and intra-doc links.🤖 Generated with Claude Code