Merge pull request #39 from rodneyosodo/wasm-support

NOISSUE - Add Binary and WASM Examples to Getting Started

.github/workflows/linter.yml

@@ -0,0 +1,28 @@
+name: Linter
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: latest
+
+      - name: Install markdownlint-cli
+        run: npm install -g markdownlint-cli
+
+      - name: run markdownlint
+        run: markdownlint --disable MD013 -- docs

.gitignore

@@ -0,0 +1,8 @@
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/

README.md

@@ -1,33 +1,46 @@
 # Cocos Docs
 
-This repo collects the collaborative work on Cocos AI documentation.
-Official documentation is hosted at [Cocos Docs page][docs].
+This repo collects the collaborative work on Cocos AI documentation. Official documentation is hosted at [Cocos Docs page](https://docs.cocos.ultraviolet.rs).
 
 Documentation is auto-generated from Markdown files in this repo.
 
 [MkDocs](https://www.mkdocs.org/) is used to serve the docs locally with different theming.
 
-## Prerequisites
+## Install
 
-Install [MkDocs](https://www.mkdocs.org/#installation)
+Doc repo can be fetched from GitHub:
 
 ```bash
-pip install mkdocs
+git clone https://github.com/ultravioletrs/cocos-docs.git
 ```
 
-Additionally, install [Material theme](https://squidfunk.github.io/mkdocs-material/):
+## Prerequisites
 
-```bash
-pip install mkdocs-material
-```
+[Python](https://www.python.org/downloads/) is required to run MkDocs.
 
-## Install
+1. Create a virtual environment:
 
-Doc repo can be fetched from GitHub:
+   ```bash
+   python -m venv venv
+   ```
 
-```bash
-git clone [email protected]:ultravioletrs/docs.git
-```
+2. Activate the virtual environment:
+
+   ```bash
+   source venv/bin/activate
+   ```
+
+3. Install [MkDocs](https://www.mkdocs.org/#installation)
+
+   ```bash
+   pip install mkdocs
+   ```
+
+4. Additionally, install [Material theme](https://squidfunk.github.io/mkdocs-material/):
+
+   ```bash
+   pip install mkdocs-material
+   ```
 
 ## Usage
 
@@ -38,6 +51,3 @@ mkdocs serve
 ```
 
 Then just point the browser to [http://127.0.0.1:8000](http://127.0.0.1:8000).
-
-
-[docs]: https://docs.cocos.ultraviolet.rs

docs/agent.md

@@ -49,4 +49,4 @@ Before execution, algorithms and datasets are validated against the computation
 
 ## Supported Algorithm types
 
-There are two supported algorithm types, binaries and python files. The default algorithm type is binaries, which is uploaded to agent using CLI. To upload a python file, the python file should be accompanied by the requirements file which will be used to provision the VM with all required libraries prior to algorithm execution. Instructions on how to provide a python file are provided in  [CLI](/cli).
+There are two supported algorithm types, binaries and python files. The default algorithm type is binaries, which is uploaded to agent using CLI. To upload a python file, the python file should be accompanied by the requirements file which will be used to provision the VM with all required libraries prior to algorithm execution. Instructions on how to provide a python file are provided in  [CLI](./cli.md).