Skip to content

Commit

Permalink
docs: cleanup (#598)
Browse files Browse the repository at this point in the history
  • Loading branch information
dtuzi authored and jmg-duarte committed Nov 22, 2024
1 parent 21e4b1b commit 0ce3b67
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 119 deletions.
26 changes: 8 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,18 @@

Welcome to the Polka Storage project repo!

This project aims to deliver a Polkadot-native system parachain for data storage.
This project aims to build a native storage network for Polkadot.

You can find our in-depth documentation at <https://eigerco.github.io/polka-storage>.
Check out the book at <https://eigerco.github.io/polka-storage/getting-started/index.html>.

* If you're looking to test the project, check out [Getting Started guide](https://eigerco.github.io/polka-storage/getting-started/index.html).
* If you're looking to get your hands dirty and help with development, take a look at [`DEVELOPMENT.md`](./DEVELOPMENT.md) to get started.

- If you'd like to contribute, take a look at [`DEVELOPMENT.md`](./DEVELOPMENT.md) to get started.

More information available about the project's genesis in:
- Weekly dev updates https://forum.polkadot.network/t/polkadot-native-storage-updates/7021

- OpenGov Referendum - Part 1 — <https://polkadot.polkassembly.io/referenda/494>
- OpenGov Referendum - Part 2 — <https://polkadot.polkassembly.io/referenda/1150>
- Research Report — <https://github.com/eigerco/polkadot-native-storage/blob/main/doc/report/polkadot-native-storage-v1.0.0.pdf>
- Polkadot Forum News Post — <https://forum.polkadot.network/t/polkadot-native-storage/4551>

---
## About Eiger

<p>
<a href="https://eiger.co">
<img
src="docs/src/images/logo.svg"
alt="Eiger Oy"
style="height: 50px; display: block; margin-left: auto; margin-right: auto; width: 50%;">
</a>
</p>
We are engineers. We contribute to various ecosystems. On Polkadot [we integrated Move to Substrate](https://x.com/Polkadot/status/1816109501394637034) allowing builders to integrate the Move VM and execute Move smart contracts. We are building Polkadot Storage (this project) and building our Jam client [Strawberry](https://github.com/eigerco/strawberry) the first serious project to go on [review](https://github.com/w3f/jam-milestone-delivery/pull/6) for reaching Milestone 1.

Contact us at hello@eiger.co
1 change: 0 additions & 1 deletion docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Summary

[Introduction](./introduction.md)
[Background](./background.md)

# Guides

Expand Down
93 changes: 0 additions & 93 deletions docs/src/background.md

This file was deleted.

14 changes: 7 additions & 7 deletions docs/src/introduction.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Introduction

Welcome to the Polka Storage project!
Welcome to the Polka Storage project book. This document is a work in progress and will be constantly updated.

This project aims to deliver a Polkadot-native system parachain for data storage.
This project aims to build a native storage network for Polkadot.

Since the Referendum approval, we've been busy developing the deliverables for Phase 2.
We've now completed Phase 2 and have started work on Phase 3.

**For [**Phase 2**](https://polkadot.polkassembly.io/referenda/1150), we have implemented:**
**During [**Phase 2**](https://polkadot.polkassembly.io/referenda/1150), we have implemented:**

- Storage Provider Pallet
- [`terminate_sectors`](./architecture/pallets/storage-provider.md#terminate_sectors)
Expand Down Expand Up @@ -37,7 +37,7 @@ Dedicated CLIs
- [`mater-cli`](./mater-cli/index.md) to convert or extract CARv2 files.
- [`storagext-cli`](./storagext-cli/index.md) to interact **directly** with the parachain — watch out, this is a low-level tool!

Filecoin actor ports:
Pallets:

- [Storage Provider](./architecture/pallets/storage-provider.md)
- [Market](./architecture/pallets/market.md)
Expand All @@ -50,7 +50,7 @@ Filecoin actor ports:
alt="Polka Storage Client Upload">
</p>

**As a refresher, for [Phase 1](https://polkadot.polkassembly.io/referenda/494), we implemented the following:**
**During [Phase 1](https://polkadot.polkassembly.io/referenda/494), we implemented the following:**

- Keeping track of [Storage Providers](./glossary.md#storage-provider),
- [Publishing](./architecture/pallets/market.md#publish_storage_deals) Market Deals on-chain,
Expand All @@ -69,7 +69,7 @@ We present a demo on how to [store a file](./getting-started/demo-file-store.md)
- OpenGov Referendum - Part 1 — <https://polkadot.polkassembly.io/referenda/494>
- OpenGov Referendum - Part 2 — <https://polkadot.polkassembly.io/referenda/1150>
- Research Report — <https://github.com/eigerco/polkadot-native-storage/blob/main/doc/report/polkadot-native-storage-v1.0.0.pdf>
- Polkadot Forum News Post — <https://forum.polkadot.network/t/polkadot-native-storage/4551>
- Weekly dev updates <https://forum.polkadot.network/t/polkadot-native-storage-updates/7021>

---

Expand Down

0 comments on commit 0ce3b67

Please sign in to comment.