Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/edgee-cloud/docs

Edgee Documentation website
https://github.com/edgee-cloud/docs

docs edge edgee http wasm wasm-component

Last synced: 30 days ago
JSON representation

Edgee Documentation website

Awesome Lists containing this project

README

        

# Edgee Documentation, made with mintlify

Edgee Documentation is a [Mintlify](https://mintlify.com/) project. The documentation is the main entry point for Edgee users.

## Prerequisites:
- **Have NodeJS installed** (we use nvm to manage the NodeJS version)

#### QuickStart Linux/OSx Dev:

```bash
## Go wherever you want
git clone [email protected]:edgee-cloud/docs.git
cd docs
nvm use
make dev.up ## This command will start the docs
```
VOILA !!!

Then you can go to https://localhost:3001

### Publishing Changes

Changes will be deployed to production automatically after pushing to the `main` branch.

#### Troubleshooting

- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
- Page loads as a 404 - Make sure you are running in a folder with `mint.json`