Skip to content

Commit

Permalink
docs: Show usage page in navigation bar
Browse files Browse the repository at this point in the history
  • Loading branch information
hopeyen committed Jun 3, 2022
1 parent 2ba0ee8 commit 9d00835
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 3 deletions.
2 changes: 1 addition & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ makedocs(;
canonical="https://graphprotocol.github.io/AllocationOpt.jl",
assets=String[],
),
pages=["Home" => "index.md"],
pages=["Home" => "index.md", "Usage" => "usage.md"],
)

deploydocs(; repo="github.com/graphprotocol/AllocationOpt.jl")
2 changes: 0 additions & 2 deletions scripts/allocationopt
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ Optimises an indexer's allocations and pushes them to the action queue.
- `filepath`: A path to the CSV file that contains whitelist, blacklist, pinnedlist, frozenlist as columns.
- `grtgas`: The maximum amount of GRT that you are willing to spend on each allocation transaction.
- `minimum_allocation_amount`: The minimum amount of GRT that you are willing to allocate to a subgraph.
- `allocation_lifetime`: The number of epoches you assume to open each allocations for. Lifetime 1 means an epoch should be closed in its second epoch
- `management_server_url`: The URL that exposes the indexer managment server, including the port. Must begin with http. Example: http://localhost:18000.
- `indexer_service_network_url`: The URL that exposes the indexer service's network endpoint. Must begin with http. Example: http://localhost:7600/network.
"""
Expand Down Expand Up @@ -42,7 +41,6 @@ Optimises an indexer's allocations and generates indexer rules to change allocat
- `filepath`: A path to the CSV file that contains whitelist, blacklist, pinnedlist, frozenlist as columns.
- `grtgas`: The maximum amount of GRT that you are willing to spend on each allocation transaction.
- `minimum_allocation_amount`: The minimum amount of GRT that you are willing to allocate to a subgraph.
- `allocation_lifetime`: The number of epoches you assume to open each allocations for. Lifetime 1 means an epoch should be closed in its second epoch
- `indexer_service_network_url`: The URL that exposes the indexer service's network endpoint. Must begin with http. Example: http://localhost:7600/network.
"""
@cast function rules(id, filepath, minimum_allocation_amount, maximum_new_allocations, indexer_service_network_url)
Expand Down

0 comments on commit 9d00835

Please sign in to comment.