Skip to content

Commit 1e6a29e

Browse files
authored
docs: address review feedback from #2457 (#77)
* docs: address BigLep's review feedback (GER-1011) Resolve the high/medium items from BigLep's review of #2457: fix broken/missing redirects, correct stale entry-point copy, and remove the misleading moved-content page. - Delete reference/general/moved-content.md (Filecoin Pin lives in-repo) and drop it from SUMMARY.md - Add redirects for builder-cookbook/data-storage/{store-data, retrieve-data,privacy-and-access-control} - Repoint builder-cookbook/dapps/{oracles,cross-chain-bridges} to build/advanced/*; fix smart-contracts/fundamentals/overview mapping - Archive the chain-data-query tutorial in legacy-content.md and repoint its redirect - Update WELCOME.md cards to the new IA labels and links - Align cookbook README with the reference-only/link-out strategy - Replace hardcoded FOC pricing with links to the FOC docs - Add a scheduled check:rpcs CI workflow - Fix stale "Was this page helpful?" prefill URLs in the cookbook * docs: mention Curio as the modern SP stack in upload guide Add Curio (with links to curiostorage.org and docs.curiostorage.org) as the modern storage-provider stack in the direct deal-making section, so the builder-facing decision page no longer reads as Boost/Lotus-only. Addresses BigLep review item 15.
1 parent 7a39e0e commit 1e6a29e

10 files changed

Lines changed: 43 additions & 25 deletions

File tree

.gitbook.yaml

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -174,10 +174,13 @@ redirects:
174174
build/tools/powergate: reference/general/README.md
175175
builder-cookbook: build/cookbook/README.md
176176
builder-cookbook/dapps: build/cookbook/README.md
177-
builder-cookbook/dapps/chain-data-query: build/cookbook/README.md
178-
builder-cookbook/dapps/cross-chain-bridges: build/cookbook/README.md
177+
builder-cookbook/dapps/chain-data-query: reference/general/legacy-content.md
178+
builder-cookbook/dapps/cross-chain-bridges: build/advanced/cross-chain-bridges.md
179179
builder-cookbook/dapps/decentralized-database: build/advanced/decentralized-databases.md
180-
builder-cookbook/dapps/oracles: build/cookbook/README.md
180+
builder-cookbook/dapps/oracles: build/advanced/oracles.md
181+
builder-cookbook/data-storage/privacy-and-access-control: build/advanced/privacy-and-access-control.md
182+
builder-cookbook/data-storage/retrieve-data: build/cookbook/retrieve-data.md
183+
builder-cookbook/data-storage/store-data: build/cookbook/store-data.md
181184
builder-cookbook/overview: build/cookbook/README.md
182185
builder-cookbook/table-of-contents: build/cookbook/README.md
183186
builder-cookbook/filecoin-pin/dapp-demo: build/cookbook/filecoin-pin/dapp-demo.md
@@ -506,7 +509,7 @@ redirects:
506509
smart-contracts/fundamentals/erc-20-quickstart: build/developing-contracts/erc-20-quickstart.md
507510
smart-contracts/fundamentals/faqs: getting-started/community/faqs.md
508511
smart-contracts/fundamentals/filecoin-evm-runtime: core-concepts/filecoin-evm-runtime/README.md
509-
smart-contracts/fundamentals/overview: storage-providers/nodes/implementations/README.md
512+
smart-contracts/fundamentals/overview: build/getting-started.md
510513
smart-contracts/fundamentals/roadmap: core-concepts/filecoin-virtual-machine/README.md
511514
smart-contracts/fundamentals/support: build/developing-contracts/support.md
512515
smart-contracts/fundamentals/the-fvm: core-concepts/filecoin-virtual-machine/README.md

.github/workflows/check-rpcs.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Check RPC endpoints
2+
3+
on:
4+
schedule:
5+
# Run every Monday at 06:17 UTC
6+
- cron: '17 6 * * 1'
7+
workflow_dispatch:
8+
9+
jobs:
10+
check-rpcs:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout repository
14+
uses: actions/checkout@v4
15+
16+
- name: Setup Node.js
17+
uses: actions/setup-node@v4
18+
with:
19+
node-version: '18'
20+
21+
- name: Install dependencies
22+
run: npm ci
23+
24+
- name: Check RPC endpoints
25+
run: npm run check:rpcs

SUMMARY.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,6 @@
170170
* [Glossary](reference/general/glossary.md)
171171
* [Specifications](reference/general/specifications.md)
172172
* [Tools](reference/general/tools.md)
173-
* [Moved content](reference/general/moved-content.md)
174173
* [Legacy Content](reference/general/legacy-content.md)
175174
* [Exchanges](reference/exchanges/README.md)
176175
* [Exchange integration](reference/exchanges/exchange-integration.md)

WELCOME.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,6 @@ layout:
2525

2626
Choose your own path to start exploring Filecoin:
2727

28-
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>💡 <strong>Learn the basics</strong></td><td>New to Filecoin and looking for foundational concepts? Start with the Basics section to understand the essentials and kick off your journey!</td><td></td><td><a href="getting-started/what-is-filecoin/">what-is-filecoin</a></td></tr><tr><td>🔧 <strong>Build with Filecoin</strong></td><td>Ready to develop on the Filecoin network? Head to the Developers section for guides and examples to help bring your project to life.</td><td></td><td><a href="core-concepts/filecoin-virtual-machine/">the-fvm.md</a></td></tr><tr><td>🏗️ <strong>Become a Storage Provider</strong></td><td>Thinking about running a provider node on Filecoin? Visit the Provider section for comprehensive guidance on getting started.</td><td></td><td><a href="storage-providers/getting-started.md">getting-started.md</a></td></tr><tr><td>📊 <strong>Store data</strong></td><td>Looking to store large volumes of data? Explore the Store section to review the various storage options Filecoin offers.</td><td></td><td><a href="getting-started/what-is-filecoin/storage-model.md">storage-model.md</a></td></tr></tbody></table>
28+
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>💡 <strong>Get started</strong></td><td>New to Filecoin and looking for foundational concepts? Start with the Getting Started section to understand the essentials and kick off your journey!</td><td></td><td><a href="getting-started/what-is-filecoin/">what-is-filecoin</a></td></tr><tr><td>🔧 <strong>Build on Filecoin</strong></td><td>Ready to develop on the Filecoin network? Head to the Build on Filecoin section for guides and examples to help bring your project to life.</td><td></td><td><a href="build/getting-started.md">getting-started.md</a></td></tr><tr><td>🏗️ <strong>Provide storage</strong></td><td>Thinking about running a provider node on Filecoin? Visit the Provide Storage section for comprehensive guidance on getting started.</td><td></td><td><a href="storage-providers/getting-started.md">getting-started.md</a></td></tr><tr><td>📊 <strong>Store data</strong></td><td>Looking to store large volumes of data? See how storage works to review the various storage options Filecoin offers.</td><td></td><td><a href="getting-started/how-storage-works/upload-to-filecoin.md">upload-to-filecoin.md</a></td></tr></tbody></table>
2929

3030
[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill_Page+URL=https://docs.filecoin.io/)

build/advanced/filecoin-onchain-cloud.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ Filecoin Onchain Cloud (FOC) is a service layer built on the Filecoin Virtual Ma
1111

1212
FOC is composed of four layers that work independently but integrate through on-chain contracts:
1313

14-
* **FWSS (Filecoin Warm Storage Service)** — warm storage optimized for frequent retrieval and verifiable availability. Pricing starts at 2.5 USDFC/TiB/month with a minimum of 2 copies.
14+
* **FWSS (Filecoin Warm Storage Service)** — warm storage optimized for frequent retrieval and verifiable availability, with a minimum of 2 copies. See the [FOC docs](https://docs.filecoin.cloud/) for current pricing.
1515
* **PDP (Proof of Data Possession)** — a cryptographic challenge-response protocol that verifies storage providers still hold your data without re-downloading it. See [PDP documentation](../../storage-providers/pdp/README.md).
1616
* **Filecoin Pay** — the on-chain settlement engine that automates payments to providers through payment rails. Providers are paid only upon verified service delivery.
17-
* **Filecoin Beam** — the data delivery layer for fast content retrieval (up to 0.014 USDFC/GiB egress).
17+
* **Filecoin Beam** — the data delivery layer for fast content retrieval, with usage-based egress pricing. See the [FOC docs](https://docs.filecoin.cloud/) for current rates.
1818

1919
## Developer tools
2020

build/cookbook/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Cookbook
22

3-
Practical recipes for building on Filecoin. Each recipe focuses on a specific task with step-by-step instructions and code examples you can adapt for your own projects.
3+
Task-focused guidance for building on Filecoin. Each page points you to the official, actively maintained tools and resources for a specific task, rather than duplicating third-party tutorials that drift out of date. The Filecoin Pin pages include full step-by-step walkthroughs.
44

55
## Table of contents
66

77
* [Store data](store-data.md) — recipes for programmable storage of public or private data on Filecoin
88
* [Retrieve data](retrieve-data.md) — recipes for fetching stored data from the network
99
* [Filecoin Pin](filecoin-pin/README.md) — recipes for using Filecoin Pin to store and retrieve data on Filecoin Onchain Cloud
1010

11-
[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill_Page+URL=https://docs.filecoin.io/build/cookbook/overview)
11+
[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill_Page+URL=https://docs.filecoin.io/build/cookbook)

build/cookbook/store-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,4 +59,4 @@ For incentive design and onboarding programs:
5959
* [Filecoin Data Onboarding](https://dataonboarding.filecoin.io/)
6060
* [Filecoin storage market basics](../../getting-started/what-is-filecoin/storage-market.md)
6161

62-
[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/build/cookbook/data-storage/store-data)
62+
[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/build/cookbook/store-data)

getting-started/how-storage-works/upload-to-filecoin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Developers interact with FOC through the [Synapse SDK](https://docs.filecoin.clo
4444

4545
## Direct deal-making
4646

47-
For full control over provider selection, pricing, and deal terms, you can negotiate storage deals directly. [Boost](https://boost.filecoin.io/) is the standard deal engine for storage providers, and the [Lotus client](../../storage-providers/nodes/implementations/lotus.md) provides CLI tools for proposing and managing deals. This path requires running infrastructure and understanding the Filecoin deal lifecycle.
47+
For full control over provider selection, pricing, and deal terms, you can negotiate storage deals directly. [Curio](https://curiostorage.org/) is the modern storage-provider stack for running this infrastructure — see the [Curio documentation](https://docs.curiostorage.org/) — with [Boost](https://boost.filecoin.io/) as the established deal engine and the [Lotus client](../../storage-providers/nodes/implementations/lotus.md) providing CLI tools for proposing and managing deals. This path requires running infrastructure and understanding the Filecoin deal lifecycle.
4848

4949
{% hint style="info" %}
5050
**Best for**: storage providers, large-scale data onboarders, and users with custom deal requirements.

reference/general/legacy-content.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,10 @@ A tutorial on creating storage deals programmatically via FVM smart contracts us
5353
* [FVM deal-making kit](https://github.com/filecoin-project/fvm-starter-kit-deal-making)
5454
* [ETHGlobal walkthrough (YouTube)](https://www.youtube.com/watch?v=27EV3gQGY9k)
5555

56+
### Chain data query
57+
58+
A tutorial on querying Filecoin chain data from a dApp using ethers.js against a public Glif JSON-RPC endpoint. For current chain access, use the [Mainnet RPCs](../../networks-and-tools/networks/mainnet/rpcs.md) or [Calibration RPCs](../../networks-and-tools/networks/calibration/rpcs.md) and the [FEVM indexers](../../build/advanced/fevm-indexers.md) guidance.
59+
5660
## Projects
5761

5862
### Saturn

reference/general/moved-content.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
 (0)