New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Consolidate UI developer docs #258
Labels
documentation
Improvements or additions to documentation
RCOS
Potential work items for RCOS student interns
UI
User Interface
Comments
ckadner
added
documentation
Improvements or additions to documentation
UI
User Interface
RCOS
Potential work items for RCOS student interns
labels
Nov 10, 2021
@ckadner I can start working on this issue |
Thanks @RRM123 for taking this up |
RRM123
added a commit
to RRM123/mlx
that referenced
this issue
Mar 29, 2022
Resolves machine-learning-exchange#258 Signed-off-by: RRM123 <[email protected]>
RRM123
added a commit
to RRM123/mlx
that referenced
this issue
Mar 29, 2022
Resolves machine-learning-exchange#258 Signed-off-by: RRM123 <[email protected]>
Submitted a PR that resolves most of the documentation issues outlined above.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
Improvements or additions to documentation
RCOS
Potential work items for RCOS student interns
UI
User Interface
There are currently 2 documents that contain UI developer content:
The
README.md
should focus on how to use the MLX API with increasing levels of complexity:docker pull mlexchange/mlx-ui:...
anddocker run ...
npm start
and the MLX API either from Docker Compose or a remote clusterdeveloper-guide.md
The UI
developer-guide.md
should focus on development aspects: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:The text was updated successfully, but these errors were encountered: