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

Documentation Update #107

Merged
merged 4 commits into from
Feb 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/targets/repo/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@ OR
mlc pull repo <repo_urll>
```

`--checkout` could be added if an user needs to checkout to a specific branch after cloning.
- The `--checkout` flag can be used if a user needs to check out a specific commit after cloning. The user must provide the commit SHA.
- The `--branch` flag can be used if a user needs to check out a specific branch after cloning. The user must provide the branch name.

Examples of `pull` action for `repo` target could be found inside the GitHub action workflow [here](https://github.com/mlcommons/mlcflow/blob/d0269b47021d709e0ffa7fe0db8c79635bfd9dff/.github/workflows/test-mlc-core-actions.yaml).

Expand All @@ -90,4 +91,5 @@ Example of `list` action for `repo` target could be found inside the GitHub acti
```bash
mlc rm repo <repo_owner>@<repo_name>
```
Example of `rm` action for `repo` target could be found inside the GitHub action workflow [here](https://github.com/mlcommons/mlcflow/blob/d0269b47021d709e0ffa7fe0db8c79635bfd9dff/.github/workflows/test-mlc-core-actions.yaml).
An example of the `rm` action for the `repo` target can be found in the GitHub Actions workflow [here](https://github.com/mlcommons/mlcflow/blob/d0269b47021d709e0ffa7fe0db8c79635bfd9dff/.github/workflows/test-mlc-core-actions.yaml).

2 changes: 1 addition & 1 deletion docs/targets/script/docker.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# **Docker Script**
# Docker Script

TBD
2 changes: 1 addition & 1 deletion docs/targets/script/test.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# **Test Script**
# Test Script

TBD
26 changes: 13 additions & 13 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ theme:
features:
- content.tabs.link
- content.code.copy
- navigation.expand
- navigation.sections
- navigation.indexes
- navigation.instant
Expand All @@ -24,18 +23,19 @@ nav:
- Install:
- install/index.md
- MLC CLI:
- RepoAction:
- targets/repo/index.md
- ScriptAction:
- targets/script/index.md
- CacheAction:
- targets/cache/index.md
- MLC Script:
- targets/script/index.md
- targets/script/execution-flow.md
- targets/script/meta.md
- targets/script/docker.md
- targets/script/test.md
- Repos:
- Repo Action:
- targets/repo/index.md
- Script:
- Script Action:
- targets/script/index.md
- targets/script/execution-flow.md
- targets/script/meta.md
- targets/script/docker.md
- targets/script/test.md
- Cache:
- Cache Action:
- targets/cache/index.md

markdown_extensions:
- pymdownx.tasklist:
Expand Down
Loading