Skip to content

Commit

Permalink
docs: fix deploy ci, update cli docs, fix xtask so it can generate them
Browse files Browse the repository at this point in the history
  • Loading branch information
gluax committed Aug 26, 2024
1 parent 3859c09 commit 67e552b
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
1 change: 1 addition & 0 deletions .github/workflows/mdbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ jobs:
- uses: actions/checkout@v4
with:
sparse-checkout: |
book.toml
snops_book
index.html
Expand Down
6 changes: 5 additions & 1 deletion crates/xtask/src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,11 @@ fn try_main() -> Result<()> {
fn clipages(sh: &Shell) -> Result<()> {
cmd!(sh, "cargo run -p snarkos-aot --features=docpages -- md").run()?;
cmd!(sh, "cargo run -p snops --features=docpages -- md").run()?;
cmd!(sh, "cargo run -p snops-agent --features=docpages -- md").run()?;
cmd!(
sh,
"cargo run -p snops-agent --features=docpages -- --id foo md"
)
.run()?;
cmd!(sh, "cargo run -p snops-cli --features=docpages -- md").run()?;
Ok(())
}
Expand Down
6 changes: 3 additions & 3 deletions snops_book/user_guide/clis/SNOPS_AGENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This document contains the help content for the `snops-agent` command-line progr

## `snops-agent`

**Usage:** `snops-agent [OPTIONS] <COMMAND>`
**Usage:** `snops-agent [OPTIONS] --id <ID> <COMMAND>`

###### **Subcommands:**

Expand All @@ -20,9 +20,9 @@ This document contains the help content for the `snops-agent` command-line progr
###### **Options:**

* `--endpoint <ENDPOINT>` — Control plane endpoint address (IP, or wss://host, http://host)
* `--id <ID>`
* `--id <ID>` — Agent ID, used to identify the agent in the network
* `--private-key-file <PRIVATE_KEY_FILE>` — Locally provided private key file, used for envs where private keys are locally provided
* `--labels <LABELS>`
* `--labels <LABELS>` — Labels to attach to the agent, used for filtering and grouping
* `--path <PATH>` — Path to the directory containing the stored data and configuration

Default value: `./snops-data`
Expand Down

0 comments on commit 67e552b

Please sign in to comment.