Skip to content
This repository was archived by the owner on Feb 26, 2026. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from 5 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
1 change: 1 addition & 0 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,4 @@ jobs:
uses: mhausenblas/mkdocs-deploy-gh-pages@master
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
REQUIREMENTS: requirements.txt
10 changes: 2 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,10 @@ git clone https://github.com/absmach/propeller-docs.git
source venv/bin/activate
```

3. Install [MkDocs](https://www.mkdocs.org/#installation)
3. Install [MkDocs](https://www.mkdocs.org/#installation) and dependencies:

```bash
pip install mkdocs
```

4. Additionally, install [Material theme](https://squidfunk.github.io/mkdocs-material/):

```bash
pip install mkdocs-material
pip install -r requirements.txt
```

## Usage
Expand Down
2 changes: 2 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ cd propeller

## Build and Install the Artifacts

To install the Magistrala CLI, follow the [instructions](https://docs.magistrala.abstractmachines.fr/getting-started/#step-2-install-the-cli).

This step compiles all Propeller components (manager, proplet, CLI, proxy, and example WASM modules).
Run the following:

Expand Down
Binary file added docs/images/monitoring.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading