Docs: add use cases

README.md

@@ -13,15 +13,19 @@ We refer to the final package that the `kit` CLI builds based on the `kitfile` a
 
 Kit's aim is to streamline the end-to-end lifecycle of AI/ML model management, making it as effortless as managing containerized applications.
 
-## Running Kit with Binaries
+## Using Kit
 
-You can download the Kit CLI using one of our [tagged versions](https://github.com/jozu-ai/kitops/tags). Make sure you get the right binary for your platform:
+### Running Kit with Binaries
+
+You can download the Kit CLI using one of our [tagged versions](https://github.com/jozu-ai/kitops/tags). The `latest` tag is used for the latest tested and stable release. This is usually the best place to start. If you want to live on the cutting edge then `next` is the tag we use to for development builds.
+
+Make sure you get the right binary for your platform:
 
 * MacOS: TODO
 * Linux: TODO
 * Windows: TODO
 
-We suggest renaming the executable once it's downloaded to just `kit` (make sure it's in your path an executable).
+We suggest renaming the executable once it's downloaded to just `kit` then make sure it's in your path and executable.
 
 Run Kit by opening a terminal and typing:
 
@@ -31,9 +35,9 @@ Run Kit by opening a terminal and typing:
 
 This will list all the commands you can use.
 
-## Building and Running Kit from Source Code
+### Building and Running Kit from Source Code
 
-You can get the Kit CLI sources from our [tagged versions](https://github.com/jozu-ai/kitops/tags).
+You can get the Kit CLI sources from our [tagged versions](https://github.com/jozu-ai/kitops/tags). The `latest` tag is used for the latest tested and stable release. This is usually the best place to start. If you want to live on the cutting edge then `next` is the tag we use to for development builds.
 
 ```shell
 go build -o kit

docs/.vitepress/config.mts

@@ -53,7 +53,9 @@ export default defineConfig({
         text: 'Getting started',
         items: [
           { text: 'Overview', link: '/docs/overview' },
-          { text: 'Installation', link: '/docs/installation' },
+          { text: 'Installation', link: '/docs/cli/installation' },
+          { text: 'Use Cases', link: '/docs/use-cases' },
+          { text: 'Why KitOps?', link: '/docs/why-kitops' },
         ]
       },
       {
@@ -65,25 +67,21 @@ export default defineConfig({
         ]
       },
       {
-        text: 'Manifest',
+        text: 'Kitfile',
         items: [
-          { text: 'Overview', link: '/docs/manifest/overview' },
-          { text: 'Structure', link: '/docs/manifest/overview' },
-          { text: 'Building and running', link: '/docs/manifest/building-running' },
-          { text: 'Creating a new model', link: '/' },
-          { text: 'Training a model', link: '/' },
-          { text: 'Strategies', link: '/' },
+          { text: 'Structure', link: '/docs/kitfile/overview' },
+          { text: 'Benefits', link: '/docs/kitfile/benefits' },
         ]
       },
       {
         text: 'MLOps with Kitfile',
         items: [
-          { text: 'Continuos integration and deployment', link: '/docs/mlops/ci-cd' },
-          { text: 'Monitoring and logging', link: '/docs/mlops/ci-cd' },
-          { text: 'Orchestration', link: '/docs/mlops/ci-cd' },
-          { text: 'Scalability and resources', link: '/docs/mlops/ci-cd' },
+          { text: 'Kit and CI/CD', link: '/docs/mlops/ci-cd' },
+          //{ text: 'Kit and model orchestration', link: '/docs/mlops/orchestration' },
+          //{ text: 'Kit and registries', link: '/docs/mlops/registries' },
         ]
       },
+      /*
       {
         text: 'Advanced',
         items: [
@@ -93,19 +91,22 @@ export default defineConfig({
           { text: 'Reinforcement and deep RL', link: '/docs/mlops/ci-cd' },
         ]
       },
+      */
       {
         text: 'Contribute',
         items: [
           { text: 'Contribute to KitOps docs', link: '/' }
         ]
       },
+      /*
       {
         text: 'Documentation Examples',
         items: [
           { text: 'Markdown Examples', link: '/markdown-examples' },
           { text: 'Runtime API Examples', link: '/api-examples' }
         ]
       }
+      */
     ],
 
     socialLinks: [
@@ -121,13 +122,14 @@ export default defineConfig({
         ariaLabel: 'JOzu Website'
       }
     ],
-
+    /*
     footer: {
       license: {
         text: 'MIT License',
         link: 'https://opensource.org/licenses/MIT'
       },
       copyright: `Copyright © ${new Date().getFullYear()} Jozu`
     }
+    */
   }
 })

docs/README.md

@@ -14,7 +14,7 @@ This is the documentation for [KitsOps](https://kitops.ml). You can read the doc
 
 ## Introduction
 
-This documentation has been built using [VitePress](https://vitepress.dev/). VitePress is a fast static site generator for building modern documentations using Vue.js. For more information please refer to the [VitePress Website](https://vitepress.dev/).
+This documentation has been built using [VitePress](https://vitepress.dev/).
 
 ## Development
 
@@ -51,11 +51,11 @@ The documentation should now be available at `http://localhost:5173`.
 
 ## Contributing Guidelines
 
-We welcome contributions from the community to help improve our project and documentation. Please follow these guidelines when contributing:
+We welcome contributions from the community to help improve our project and documentation. Please read our [Guide to Contributing](../CONTRIBUTING.md) and follow these guidelines:
 
 ### Reporting Bugs and Issues
 
-If you encounter any bugs or issues with the documentation, please report them in our [GitHub issue tracker](https://github.com/jozu-ai/kitops/issues). Be sure to provide clear details about the problem, including steps to reproduce if possible.
+If you encounter any bugs or issues with the documentation, please report them in our [GitHub issue tracker](https://github.com/jozu-ai/kitops/issues) and add the `docs` label. Be sure to provide clear details about the problem, including steps to reproduce if possible.
 
 ### Submitting Pull Requests
 

docs/src/docs/cli/installation.md

@@ -9,6 +9,8 @@ To begin, you will need to download the latest version of `kit`. You can find th
 
 [Download the latest `kit` release](https://github.com/jozu-ai/kitops/releases/latest)
 
+Or, if you're feeling frisky try the cutting edge [`next` release](https://github.com/jozu-ai/kitops/releases/latest). Just remember that's not fully tested so YMMV.
+
 #### Selecting the Correct Version for Your Platform
 
 Depending on your operating system and its architecture, you will need to download a specific build of `kit`. Below is a table to help you identify the correct file to download for your platform:

docs/src/docs/cli/usage.md

@@ -8,23 +8,67 @@ The `kit CLI` is a tool to easily and quickly manage models.
 $ ./kit [command]
 ```
 
+You can always get help on a command by adding the `-h` flag.
+
 Available Commands:
 
 | Command |	Description |
 | ---- | --- |
-| `build` | Build a model |
+| `build` | Build a ModelKit |
 | `completion` | Generate the autocompletion script for the specified shell |
+| `dev` | Run the serialized model | <!-- starts a server on a given port and drops the model in there for inference -->
+| `fetch` | Updating the local respository for a ModelKit from the remote |
 | `help` | Help about any command |
-| `login` | A brief description of your command |
-| `list` | List model kits |
-| `pull` | Pull model from registry |
-| `push` | Push model to registry |
-| `version` | Display the version information for kit |
+| `login` | Login to the remote repository |
+| `logout` | Logout to the remote repository |
+| `list` | List ModelKits |
+| `pull` | Pull one or more of the model, dataset, code, and Kitfile into a destination folder |
+| `push` | Push ModelKit to respository |
+| `remove` | Removed the ModelKit from the local repository |
+| `tag` | Tags a ModelKit |
+| `version` | Display the version information for Kit |
 
 ## Example
 
-To list your available model kits you can do:
+To list your available ModelKit:
 
 ```sh
 $ ./kit list
 ```
+
+To build a ModelKit for your model:
+
+```sh
+$ ./kit build ../examples/onnx -t localhost:5050/example-repo:example-tag"
+```
+
+Then you can push it to your registry:
+
+```sh
+$ ./kit push localhost:5050/example-repo:example-tag --http
+```
+
+After you finish calling all your friends and telling them about Kit they can fetch your ModelKit and run it:
+
+```sh
+$ ./kit fetch localhost:5050/test-repo:test-tag --http
+$ ./kit dev
+```
+
+Maybe one of your friends only wants the dataset you used:
+
+```sh
+$ ./kit pull -filter dataset
+```
+
+Another friend only needs the model so they can integrate it with their application:
+
+```sh
+$ ./kit pull -filter model
+```
+
+To see the Kitfile associated with a ModelKit:
+
+```sh
+$ ./kit pull -filter kitfile
+```

docs/src/docs/compatibility.md

@@ -0,0 +1,41 @@
+# Compatible Tools
+
+The KitOps project is about smoothing the transition from AI/ML teams to production operations teams. We're not trying to change the tools each use, Kit just creates a package that every team can use with their preferred toolset.
+
+Kit packages up everything your AI/ML model needs to be integrated with application (or other models), run locally, or deployed to inference infrastructure. We use standards like JSON, YAML, OCI-assets, and TAR files so nearly everything is compatible with a ModelKit. This includes both common ML tools and standard DevOps toolchains.
+
+A few examples in alphabetical order:
+* Amazon SageMaker, EKS, EC2, ECR, Fargate, Lambda, S3, etc...
+* Azure ML, AKS, Cloud, Container Registry, etc...
+* Circle CI
+* Comet ML
+* Databricks
+* DataRobot
+* Domino
+* Docker
+* Docker Hub
+* DvC
+* GitHub
+* GitLab
+* Google Vertex, GKS, GCP, Artifact Registry, etc...
+* Hugging Face
+* IBM Cloud, Cloud Container Regsitry
+* JFrog Artifactory
+* Jupyter notebooks
+* Kubernetes / Kserve
+* MLFlow
+* Neptune.ai
+* NVIDIA Triton
+* OctoML
+* Prefect
+* Quay.io
+* Ray
+* Red Hat OpenShift
+* Run.ai
+* Seldon
+* Tensorflow Hub
+* VMware
+* Weights & Biases
+* ZenML
+
+If you've tried using Kit with your favourite tool and are having trouble, please open an issue in our GitHub repository.

docs/src/docs/manifest/building-running.md → docs/src/docs/kitfile/benefits.md

@@ -1,4 +1,4 @@
-# Building and running
+# Benefits
 
 Some introductory text here
 

docs/src/docs/kitfile/overview.md

@@ -0,0 +1,5 @@
+# Kitfiles
+
+Kitfiles be cool, bruh.
+
+## Format