Skip to content

docs: expand the testing guide with frontend commands - #9294

Merged
lstein merged 9 commits into
invoke-ai:mainfrom
wunianze666-netizen:docs/expand-testing-guide
Aug 12, 2026
Merged

docs: expand the testing guide with frontend commands#9294
lstein merged 9 commits into
invoke-ai:mainfrom
wunianze666-netizen:docs/expand-testing-guide

Conversation

@wunianze666-netizen

Copy link
Copy Markdown
Contributor

Summary

  • replace the unfinished frontend testing TODO with concrete Vitest commands
  • document how to run the frontend tests from the repo root or from invokeai/frontend/web
  • replace the aspirational backend organization note with a clearer description of the current state

Why

The testing guide currently exposes an unfinished TODO in the published docs. This change makes the page immediately usable for contributors who want to run frontend tests locally.

@github-actions github-actions Bot added the docs PRs that change docs label Jun 18, 2026
@lstein
lstein requested a review from joshistoast July 10, 2026 01:57
@lstein lstein added the 6.14.0 label Jul 10, 2026
@lstein lstein moved this to 6.14.x Theme: USER EXPERIENCE in Invoke - Community Roadmap Jul 10, 2026

@joshistoast joshistoast left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewing from my phone rn, this looks fairly above board. A couple non-blockers I'd probably change though:

  1. Not sure it's worth talking about where to expect the test files and then afterwards say that a lot don't follow that expectation.

  2. Maybe we can mention the makefile commands we have for running the testing suite. Either as an additional set of commands or replace the mentioned ones.

Copy link
Copy Markdown
Contributor Author

Thanks for the suggestions — I've updated the guide to address both points.

  • removed the frontend test location note so the section stays focused on runnable commands
  • added the repo-root make shortcuts alongside the existing direct commands
  • softened the backend organization note to avoid overstating the current layout

Happy to make another pass if you'd prefer a different command mix.

@joshistoast joshistoast left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These look good, maybe separate the make and pnpm tests with starlight tabs and I'll approve

@lstein

lstein commented Jul 27, 2026

Copy link
Copy Markdown
Collaborator

@wunianze666-netizen This is ready to go after you address @joshistoast 's request to put the docs in separate starlight tabs.

Copy link
Copy Markdown
Contributor Author

Thanks, I've separated the frontend commands into Starlight tabs:

  • Make contains the repo-root shortcut
  • pnpm contains the direct frontend test commands

I also rebased the branch on the latest main merge. git diff --check passes; the local docs build could not be run because this checkout does not have docs/node_modules installed.

Comment thread docs/src/content/docs/development/Guides/tests.mdx

Copy link
Copy Markdown
Contributor Author

Thanks for catching that. I added the missing Starlight component import in 0e01eae.

I also installed the docs dependencies and ran pnpm build locally; it completed successfully with all internal links valid. All PR checks, including docs / check-and-build, are now passing.

Copy link
Copy Markdown
Contributor Author

Synced the branch with the current main in f06a565. The requested Starlight component import is present, and the Make/pnpm tabs build correctly.

I reran the full docs build after the sync: 314 pages generated and all internal links valid. I also marked the now-addressed import thread as resolved. @joshistoast, could you please re-review when convenient?

@joshistoast joshistoast left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@lstein
lstein enabled auto-merge (squash) August 12, 2026 17:40
@lstein
lstein merged commit 5e5d7fb into invoke-ai:main Aug 12, 2026
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

6.14.0 docs PRs that change docs

Projects

Status: 6.14.x Theme: USER EXPERIENCE

Development

Successfully merging this pull request may close these issues.

4 participants