Skip to content

Commit e03034f

Browse files
authored
Add dev doc links to CONTRIBUTING.md (#312)
Resolves a task from #304 Signed-off-by: Rafael Vasquez <[email protected]>
1 parent 5ac6c47 commit e03034f

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

CONTRIBUTING.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,14 @@ maintainers of each component affected.
3232

3333
For a list of the maintainers, see the [MAINTAINERS.md](MAINTAINERS.md) page.
3434

35+
## Getting Started
36+
37+
**MLX Dashboard Web UI**
38+
- Information regarding configuration, deployment, and development setup can be found [here](https://github.com/machine-learning-exchange/mlx/blob/main/dashboard/origin-mlx/README.md).
39+
40+
**MLX API**
41+
- Quickstart and development setup documentation can be found [here](https://github.com/machine-learning-exchange/mlx/tree/main/api).
42+
3543
## Legal
3644

3745
Each source file must include a license header for the Apache
@@ -72,14 +80,6 @@ git commit -s
7280
## Communication
7381
Please feel free to connect with us on our [Slack channel](https://lfaifoundation.slack.com/archives/C0264LKNH63).
7482

75-
## Setup
76-
**FIXME** Please add any special setup instructions for your project to help the developer
77-
become productive quickly.
78-
79-
## Testing
80-
**FIXME** Please provide information that helps the developer test any changes they make
81-
before submitting.
82-
8383
## Coding style guidelines
8484
**FIXME** Optional, but recommended: please share any specific style guidelines you might
8585
have for your project.

0 commit comments

Comments
 (0)