docs: align UI component command guidance with scripts#416
Open
DivyamTalwar wants to merge 1 commit into
Open
Conversation
The agent guidance listed npm run build:package, but the UI package does not define that script. The UI README also described the checked-in private package as an installable @morphik/ui package and included incomplete component-prop guidance. Update both docs to describe the local UI workflow, the supported npm run build / npm start path, the default local connection path, and verified connection-state behavior. Constraint: Keep the PR documentation-only; do not change package scripts, package metadata, or component props without maintainer evidence of a publish workflow. Rejected: Add a build:package npm script | no checked-in script or build flow requires it, and the existing README/Docker compose path uses npm run build. Rejected: Wire README-only props into MorphikUI | component behavior changes are out of scope for this docs correction. Confidence: high Scope-risk: narrow Directive: Keep future UI command, connection, and component guidance verified against ee/ui-component/package.json, npm run output, and the current UI source. Tested: npm run (from ee/ui-component); rg -n "build:package|@morphik/ui|npm install @morphik/ui|onUriChange|isReadOnlyUri|Automatic reconnection|localhost:8000|npm run build|npm run lint|format:check|npm run format|npm start" CLAUDE.md ee/ui-component/package.json ee/ui-component/README.md docker-compose.run.yml -S; git diff --check Not-tested: npm run build; npm run lint; full frontend dependency install
DivyamTalwar
marked this pull request as ready for review
July 3, 2026 20:57
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
1 participant
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
CLAUDE.mdlistednpm run build:packagefor the UI component, butee/ui-component/package.jsondoes not define that script. The UI README also described the checked-in package as an installable@morphik/uipackage and included stale component-prop guidance even though the package is private and namedmorphik-ui. This updates the local UI guidance so it matches the actual frontend scripts and package metadata.Changes
npm run build:packagecommand inCLAUDE.mdwith the supportednpm startproduction-server command.@morphik/uipackage.onUriChangeprop.Why this matters
Agent and UI development command references should be executable. Removing stale commands and package-install claims prevents wasted debugging time when someone follows the checked-in UI workflow.
Tests
Commands run:
npm runfromee/ui-component- passed; listeddev,build,start,lint,format, andformat:check, with nobuild:packagescript.rg -n "build:package|@morphik/ui|npm install @morphik/ui|onUriChange|isReadOnlyUri|Automatic reconnection|localhost:8000|npm run build|npm run lint|format:check|npm run format|npm start" CLAUDE.md ee/ui-component/package.json ee/ui-component/README.md docker-compose.run.yml -S- passed; stale package-build, package-install, component-prop, and feature-bullet references were removed while current build/start commands and default local connection guidance remain documented.git diff --check origin/main...HEAD- passed.Not run:
npm run build; this PR only updates documentation and does not change frontend code or package scripts.npm run lint; same reason.Risk
Risk level: low
This is a documentation correction with no runtime behavior change. Rollback is a direct revert of the
CLAUDE.mdandee/ui-component/README.mdedits.Issue
No existing issue. This was discovered during repository analysis.
Notes for maintainers
I intentionally did not add a replacement
build:packagescript because the supported checked-in workflow is the existingnpm run build/npm startpath, not a package-build script.