diff --git a/README.md b/README.md index d34a1fd..145ebb1 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,6 @@ -# mdBook of Polka Storage +# Home of the Polka Storage Book -## Development +> [!WARNING] +> If you find issues, please file them [here](https://github.com/eigerco/polka-storage-book/issues/new)! -```bash -mdbook serve -``` - -## Build - -```bash -mdbook build -``` - -## Reference - -[mdBook docs](https://rust-lang.github.io/mdBook/) \ No newline at end of file +To read the book, please head to . diff --git a/src/pallets/market.md b/src/pallets/market.md index b5f721b..1439c57 100644 --- a/src/pallets/market.md +++ b/src/pallets/market.md @@ -222,8 +222,8 @@ The Market Pallet actions can fail with following errors: - Deal is not pending. - `DealsTooLargeToFitIntoSector` - Sum of all deals piece sizes for a sector exceeds sector size. The sector size is based on the registered proof type. We currently only support registered `StackedDRG2KiBV1P1` proofs, which have 2KiB sector sizes. - `TooManyDealsPerBlock` - Tried to activate too many deals at a given `start_block`. -- `UnexpectedValidationError` - `publish_storage_deals`'s core logic was invoked with a broken invariant that should be called by `validate_deals`. Please report an issue to the developers. -- `DealPreconditionFailed` - Due to a programmer bug. Please report an issue to the developers. +- `UnexpectedValidationError` - `publish_storage_deals`'s core logic was invoked with a broken invariant that should be called by `validate_deals`. Please [report an issue](https://github.com/eigerco/polka-storage-book/issues/new) to the developers. +- `DealPreconditionFailed` - Due to a programmer bug. Please [report an issue](https://github.com/eigerco/polka-storage-book/issues/new) to the developers. ## Constants diff --git a/src/pallets/storage-provider.md b/src/pallets/storage-provider.md index c323cf4..7950e6d 100644 --- a/src/pallets/storage-provider.md +++ b/src/pallets/storage-provider.md @@ -323,16 +323,16 @@ The Storage Provider Pallet actions can fail with the following errors: - `InvalidUnsealedCidForSector` - This error is emitted when the declared unsealed_cid for pre_commit is different from the one calculated by the system. - `FaultDeclarationTooLate` - A fault declaration was submitted after the fault declaration cutoff. The fault declaration can be submitted after the upcoming deadline is closed. - `FaultRecoveryTooLate` - A fault recovery was submitted after the fault recovery cutoff. The fault recovery can be submitted after the upcoming deadline is closed. -- `DeadlineError` - An error was encountered in the deadline module. Please report an issue to the developers. -- `PartitionError` - An error was encountered in the partition module. Please report an issue to the developers. -- `StorageProviderError` - An error was encountered in the storage provider module. Please report an issue to the developers. +- `DeadlineError` - An error was encountered in the deadline module. Please [report an issue](https://github.com/eigerco/polka-storage-book/issues/new) to the developers. +- `PartitionError` - An error was encountered in the partition module. Please [report an issue](https://github.com/eigerco/polka-storage-book/issues/new) to the developers. +- `StorageProviderError` - An error was encountered in the storage provider module. Please [report an issue](https://github.com/eigerco/polka-storage-book/issues/new) to the developers. - `SectorMapError` - An error was encountered in the sector map module. These errors can be: - - `FailedToInsertSector` - Internal bounds violation with Sectors. Please report an issue to the developers. - - `FailedToInsertPartition` - Internal bounds violation with partitions. Please report an issue to the developers. -- `CouldNotActivateSector` - Failure during prove commit when trying to convert a previously pre-committed sector due to a programming error. Please report an issue to the developers. -- `CouldNotVerifySectorForPreCommit` - Failure during pre-commit due to the [commd](../glossary.md#commitment-of-data) calculation failing due to a programming error. Please report an issue to the developers. -- `SlashingFailed` - Slashing of funds fails due to a programmer error. Please report an issue to the developers. -- `ConversionError` - Due to a programmer error. Please report an issue to the developers. + - `FailedToInsertSector` - Internal bounds violation with Sectors. Please [report an issue](https://github.com/eigerco/polka-storage-book/issues/new) to the developers. + - `FailedToInsertPartition` - Internal bounds violation with partitions. Please [report an issue](https://github.com/eigerco/polka-storage-book/issues/new) to the developers. +- `CouldNotActivateSector` - Failure during prove commit when trying to convert a previously pre-committed sector due to a programming error. Please [report an issue](https://github.com/eigerco/polka-storage-book/issues/new) to the developers. +- `CouldNotVerifySectorForPreCommit` - Failure during pre-commit due to the [commd](../glossary.md#commitment-of-data) calculation failing due to a programming error. Please [report an issue](https://github.com/eigerco/polka-storage-book/issues/new) to the developers. +- `SlashingFailed` - Slashing of funds fails due to a programmer error. Please [report an issue](https://github.com/eigerco/polka-storage-book/issues/new) to the developers. +- `ConversionError` - Due to a programmer error. Please [report an issue](https://github.com/eigerco/polka-storage-book/issues/new) to the developers. ## Pallet constants