-
Notifications
You must be signed in to change notification settings - Fork 54
Open
Labels
RCOSPotential work items for RCOS student internsPotential work items for RCOS student internsUIUser InterfaceUser InterfacedocumentationImprovements or additions to documentationImprovements or additions to documentation
Description
There are currently 2 documents that contain UI developer content:
- dashboard/origin-mlx/README.md
- https://github.com/machine-learning-exchange/mlx/blob/main/dashboard/origin-mlx/developer-guide.md
The README.md should focus on how to use the MLX API with increasing levels of complexity:
- point to quickstart guide, show commands to bring up the stack with and without UI, point to existing cluster deployment instructions
- start the UI using existing docker image
docker pull mlexchange/mlx-ui:...anddocker run ... - start the UI using local code with
npm startand the MLX API either from Docker Compose or a remote cluster - point to UI
developer-guide.md
The UI developer-guide.md should focus on development aspects:
- UI code structure and design principles
- build the UI docker image from local code, push the image, deploy to cluster
- developer setup with docker compose
- code contribution guidelines, linting, updating npm dependencies, creating PRs, etc
Remove this outdated OLD_README.md:
Where-ever the UI is brought up (Docker Compose or via npm start) add the environment variables to disable the UI cache during development:
export REACT_APP_TTL=0
export REACT_APP_CACHE_INTERVAL=0Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
RCOSPotential work items for RCOS student internsPotential work items for RCOS student internsUIUser InterfaceUser InterfacedocumentationImprovements or additions to documentationImprovements or additions to documentation