Skip to content

Commit

Permalink
Merge pull request #39 from rodneyosodo/wasm-support
Browse files Browse the repository at this point in the history
NOISSUE - Add Binary and WASM Examples to Getting Started
  • Loading branch information
drasko authored Aug 20, 2024
2 parents 3d15d88 + 44993fd commit 5fe6758
Show file tree
Hide file tree
Showing 15 changed files with 998 additions and 138 deletions.
28 changes: 28 additions & 0 deletions .github/workflows/linter.yml
Original file line number Diff line number Diff line change
@@ -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
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
44 changes: 27 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
2 changes: 1 addition & 1 deletion docs/agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Loading

0 comments on commit 5fe6758

Please sign in to comment.