docs: document Studio frontend build step for source installs#72
Merged
Conversation
A fresh `git clone` does not include the pre-built Studio SPA, so running
`firefly studio` from source returns `{"detail":"Not Found"}` until the
frontend is built. The `scripts/build_studio.py` helper already exists
(used by the desktop and release CI workflows) but was not referenced
from CONTRIBUTING.md or docs/studio.md, leaving source users to discover
the requirement by hand.
- CONTRIBUTING.md: add Node.js 20+ to prerequisites and a "Building the
Studio Frontend" subsection pointing at scripts/build_studio.py.
- docs/studio.md: scope the "pre-built and bundled" claim to the published
wheel, add a callout for source checkouts, and promote the helper
script in the Frontend Development section.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The helper script is the recommended path; listing the equivalent npm commands underneath duplicates what the script already does. Keep the docs minimal. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
miguelgfierro
approved these changes
Apr 27, 2026
Contributor
There was a problem hiding this comment.
TODO aquí, vamos a sacar la parte de studio a otra repo: https://github.com/[fireflyframework/fireflyframework-agentic-studio](https://github.com/fireflyframework/fireflyframework-agentic-studio)
ancongui
pushed a commit
that referenced
this pull request
May 31, 2026
docs: document Studio frontend build step for source installs
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
2 participants
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
git clonedoesn't ship the pre-built Studio SPA, sofirefly studioreturns{"detail":"Not Found"}on every page until the frontend is built.scripts/build_studio.pyalready automates the build (it's wired into the desktop and release CI workflows), but no contributor-facing doc pointed at it — source users had to figure this out themselves.CONTRIBUTING.mdand adds a callout + updated dev section indocs/studio.md.Changes
uv run python scripts/build_studio.py.npmsteps kept as the equivalent fallback).No code or behavior changes; docs only.
Test plan
CONTRIBUTING.mdrenders cleanly on GitHubdocs/studio.mdrenders cleanly and the in-page anchor#frontend-developmentstill resolvesuv sync --all-extras && uv run python scripts/build_studio.py && firefly studioserves the UI (no{"detail":"Not Found"})🤖 Generated with Claude Code