mirror of
https://github.com/psviderski/uncloud.git
synced 2026-11-10 12:44:16 +00:00
chore(docs): update documentation generation commands and regenerate reference docs
This commit is contained in:
+25
-2
@@ -35,10 +35,11 @@ Build the CLI:
|
||||
go build -o uc ./cmd/uc
|
||||
```
|
||||
|
||||
Or build and run the CLI with a single command:
|
||||
Or build and run the CLI with mise. It forwards arguments, including help flags, directly to the CLI:
|
||||
|
||||
```shell
|
||||
go run ./cmd/uc --help
|
||||
mise uc --help
|
||||
mise uc image rm -h
|
||||
```
|
||||
|
||||
The Uncloud daemon (`uncloudd`) only supports Linux, so you need to cross-compile it if you're developing on macOS or
|
||||
@@ -119,6 +120,28 @@ Regenerate mocks:
|
||||
mise run mocks
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
Regenerate the CLI reference docs after changing commands or flags:
|
||||
|
||||
```shell
|
||||
mise run docs:cli
|
||||
```
|
||||
|
||||
To preview the documentation website, install its dependencies from the project root:
|
||||
|
||||
```shell
|
||||
npm ci --prefix website
|
||||
```
|
||||
|
||||
Then start the local development server:
|
||||
|
||||
```shell
|
||||
mise run docs:dev
|
||||
```
|
||||
|
||||
The server opens the site (http://localhost:3000/) in your browser and reloads it as you edit files in `website/`.
|
||||
|
||||
## Uncloud in Docker (UCinD)
|
||||
|
||||
The [`ucind`](./cmd/ucind) CLI lets you run Uncloud clusters locally using Docker containers instead of real machines.
|
||||
|
||||
Reference in New Issue
Block a user