Skip to content
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

Open
ckadner opened this issue Nov 10, 2021 · 3 comments
Open

Consolidate UI developer docs #258

ckadner opened this issue Nov 10, 2021 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation RCOS Potential work items for RCOS student interns UI User Interface

Comments

@ckadner
Copy link
Member

ckadner commented Nov 10, 2021

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:

  1. point to quickstart guide, show commands to bring up the stack with and without UI, point to existing cluster deployment instructions
  2. start the UI using existing docker image docker pull mlexchange/mlx-ui:... and docker run ...
  3. start the UI using local code with npm start and the MLX API either from Docker Compose or a remote cluster
  4. point to UI developer-guide.md

The UI developer-guide.md should focus on development aspects:

  1. UI code structure and design principles
  2. build the UI docker image from local code, push the image, deploy to cluster
  3. developer setup with docker compose
  4. 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=0
@ckadner ckadner added documentation Improvements or additions to documentation UI User Interface RCOS Potential work items for RCOS student interns labels Nov 10, 2021
@RRM123
Copy link
Contributor

RRM123 commented Mar 8, 2022

@ckadner I can start working on this issue

@ckadner
Copy link
Member Author

ckadner commented Mar 9, 2022

Thanks @RRM123 for taking this up

RRM123 added a commit to RRM123/mlx that referenced this issue Mar 29, 2022
RRM123 added a commit to RRM123/mlx that referenced this issue Mar 29, 2022
@RRM123
Copy link
Contributor

RRM123 commented Mar 29, 2022

Submitted a PR that resolves most of the documentation issues outlined above.
The remaining tasks are these changes to the developer-guide.md:

  1. build the UI docker image from local code, push the image, deploy to cluster
  2. developer setup with docker compose
  3. code contribution guidelines, linting, updating npm dependencies, creating PRs, etc

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
Projects
None yet
Development

No branches or pull requests

2 participants