From 980f813cfda98a20e22d8f7d2cc156dcc2e0e91c Mon Sep 17 00:00:00 2001 From: mintybasil <163682877+mintybasil@users.noreply.github.com> Date: Fri, 7 Nov 2025 11:42:42 -0500 Subject: [PATCH 1/2] Fix pricing priority options --- documentation/site/pages/provers/broker.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/site/pages/provers/broker.mdx b/documentation/site/pages/provers/broker.mdx index f292585a4..b91c54dec 100644 --- a/documentation/site/pages/provers/broker.mdx +++ b/documentation/site/pages/provers/broker.mdx @@ -73,8 +73,8 @@ Below are all `broker.toml` settings organized by section: | set\_builder\_default\_image\_url | Default URL for set builder image. This URL will be tried first before falling back to the image URL from the set verifier contract. | | max\_concurrent\_proofs | Maximum number of concurrent proofs that can be processed at once. Used to limit proof tasks spawned to prevent overwhelming the system. | | max\_concurrent\_preflights | Maximum number of orders to concurrently preflight. Used to limit preflight tasks spawned to prevent overwhelming the system. | -| order\_pricing\_priority | Determines how orders are prioritized for pricing. Options: "random" (process orders in random order), "observation_time" (FIFO), "shortest_expiry" (earliest deadline), "price" (highest ETH payment), "cycle_price" (highest ETH price per cycle, default). | -| order\_commitment\_priority | Determines how orders are prioritized when committing to prove them. Options: "random" (process orders in random order, default), "shortest_expiry" (process orders by shortest expiry first). | +| order\_pricing\_priority | Determines how orders are prioritized for pricing. Options: "random" (process orders in random order, default), "observation_time" (Process orders in the order they were observed (FIFO)), "shortest_expiry" (process orders by shortest expiry first). | +| order\_commitment\_priority | Determines how orders are prioritized when committing to prove them. Options: "random" (process orders in random order), "shortest_expiry" (earliest deadline), "price" (highest ETH payment), "cycle_price" (highest ETH price per cycle, default). | | max\_critical\_task\_retries | Max critical task retries on recoverable failures. The broker service has a number of subtasks. Some are considered critical. If a task fails, it will be retried, but after this number of retries, the process will exit. | | allow\_client\_addresses | Optional allow list for customer address. If enabled, all requests from clients not in the allow list are skipped. | | deny\_requestor\_addresses | Optional deny list for requestor address. If enabled, all requests from clients in the deny list are skipped. | From 545069e0f30f31084efd216fdc15e1f892354082 Mon Sep 17 00:00:00 2001 From: mintybasil <163682877+mintybasil@users.noreply.github.com> Date: Tue, 11 Nov 2025 12:30:27 -0500 Subject: [PATCH 2/2] Update docs readme --- README.md | 9 +-------- documentation/README.md | 13 ++++++++++--- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 5f81658de..7e699ccf4 100644 --- a/README.md +++ b/README.md @@ -65,14 +65,7 @@ cargo build You can find the documentation in the [documentation](./documentation) folder. -To build it and serve it locally, run the following commands: - -```sh -bun install -bun run docs -``` - -Then open your browser and navigate to `http://localhost:5173`. +See the [README](./documentation/README.md) for instructions on how to build and contribute to the docs. ## Audits diff --git a/documentation/README.md b/documentation/README.md index ec4728548..b8a4bfd05 100644 --- a/documentation/README.md +++ b/documentation/README.md @@ -9,6 +9,7 @@ Welcome to the Boundless documentation. ## Prerequisites +- [Node.js](https://nodejs.org/en) >= 24.0 - [Bun](https://bun.sh) ## Getting Started @@ -19,19 +20,25 @@ Welcome to the Boundless documentation. git clone https://github.com/boundless-xyz/boundless.git ``` -2. Install dependencies +2. Navigate to the `documentation/` directory + +```bash +cd boundless/documentation +``` + +3. Install dependencies ```bash bun install ``` -3. Start the development server +4. Start the development server ```bash bun run dev ``` -4. Open your browser and navigate to `http://localhost:5173` +5. Open your browser and navigate to `http://localhost:5173` ## Contributing