Skip to content

Commit 4ef7589

Browse files
authored
Merge pull request #2399 from filecoin-project/bp/seo-search-improvements
Add keywords to multiple documentation files for improved SEO and discoverability
2 parents f7c0962 + 9a67338 commit 4ef7589

File tree

7 files changed

+64
-16
lines changed

7 files changed

+64
-16
lines changed

basics/assets/the-fil-token.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: >-
33
FIL is the cryptocurrency that powers the Filecoin network. This page explains
44
what FIL is, how it can be used, and its denominations.
5+
keywords: "FIL token, FIL cryptocurrency, Filecoin token, what is FIL, FIL coin, get FIL"
56
---
67

78
# The FIL token

basics/how-storage-works/filecoin-and-ipfs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ The code that runs both clients and storage providers is open-source. Storage pr
7171

7272
#### Active community
7373

74-
Filecoin has an active community of contributors to answer questions and help newcomers get started. There is an open dialog between users, developers, and storage providers. If you need help, you can reach the person who designed or built the system in question. Reach out on [Filecoin’s chat and forums](https://docs.filecoin.io/basics/project-and-community/chat-and-discussion-forums/).
74+
Filecoin has an active community of contributors to answer questions and help newcomers get started. There is an open dialog between users, developers, and storage providers. If you need help, you can reach the person who designed or built the system in question. Reach out on [Filecoin’s chat and forums](https://docs.filecoin.io/basics/project-and-community/forums-and-fips).
7575

7676

7777

basics/project-and-community/forums-and-FIPs.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,36 +5,36 @@ description: >-
55
of choice.
66
---
77

8-
# Discussion Forums and Filecoin Improvement Proposals
8+
# Discussion Forums and Filecoin Improvement Proposals
99

1010
### Discussion Forums
1111

12-
For shorter-lived discussions, our community chat open to all on both Slack and Discord:
12+
For shorter-lived discussions, our community chat open to all on both Slack and Discord:
1313

14-
* [Slack](https://filecoin.io/slack/)
14+
* [Slack](https://filecoin.io/slack)
1515
* [Discord](https://discord.com/invite/filecoin)
1616

1717
For long-lived discussions and for support, please use the [discussion tab on GitHub](https://github.com/filecoin-project/community#forums) instead of Slack. It’s easy for complex discussions to get lost in a sea of new messages on those chat platforms, and posting longer discussions and support requests on the forums helps future visitors, too.
1818

1919
### Filecoin improvement proposals
2020

21-
Filecoin improvement proposals (FIPs) are design documents that propose changes and improvements to the Filecoin network, giving detailed specifications and their rational, and allowing the community to document their consensus or dissent. All technical FIPs that are accepted are later reflected in the [Filecoin Spec](https://spec.filecoin.io/).
21+
Filecoin improvement proposals (FIPs) are design documents that propose changes and improvements to the Filecoin network, giving detailed specifications and their rational, and allowing the community to document their consensus or dissent. All technical FIPs that are accepted are later reflected in the [Filecoin Spec](https://spec.filecoin.io/).
2222

23-
There are three types of FIPs:
23+
There are three types of FIPs:
2424
* Technical FIPs (FTP): protocol changes, standards, API changes. They can include core (consensus-related changes, networking (network protocol improvements, interface (API/RPC or language-level updates), or can be informational (updates to general guidelines or documentation).
2525
* Organizational FIPs (FOP): changes to processes, tools, or governance.
2626
* Recovery FIPs (FRP): emergency fixes requiring state changes (e.g., major bugs).
2727

28-
Typically, the FIP lifecycle looks something like this:
28+
Typically, the FIP lifecycle looks something like this:
2929

3030
[ WIP ] -> [ DRAFT ] -> [ LAST CALL ] -> [ ACCEPTED ] -> [ FINAL ]
3131

32-
1. WIP: A community member has an idea for a FIP, and begins discussing the idea publicly on the Filecoin Discord, in the [Filecoin Slack channel for discussing FIPs](https://filecoinproject.slack.com/archives/C01EU76LPCJ), or in Github issues for the relevant repo.
32+
1. WIP: A community member has an idea for a FIP, and begins discussing the idea publicly on the Filecoin Discord, in the [Filecoin Slack channel for discussing FIPs](https://filecoinproject.slack.com/archives/C01EU76LPCJ), or in Github issues for the relevant repo.
3333
2. DRAFT: If there is a chance the FIP could be adopted, the author submits a draft for the FIP as a pull request in the [FIPs repo](https://github.com/filecoin-project/FIPs).
3434
3. LAST CALL: This status allows the community to submit final changes to the draft.
35-
4. ACCEPTED: Once the FIP is voted on and accepted, the core engineers will work to implement it.
35+
4. ACCEPTED: Once the FIP is voted on and accepted, the core engineers will work to implement it.
3636
5. FINAL: This status represents the current state-of-the-art, and it should only be updated to correct errors.
3737

3838
It is the authors' responsibility to request status updates for the FIP. A more robust explainer of the FIP process can be found in [FIP001](https://github.com/filecoin-project/FIPs/blob/master/FIPS/fip-0001.md#what-is-a-fip).
3939

40-
[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/project-and-community/chat-and-discussion-forums)
40+
[Was this page helpful?](https://airtable.com/apppq4inOe4gmSSlk/pagoZHC2i1iqgphgl/form?prefill\_Page+URL=https://docs.filecoin.io/basics/project-and-community/forums-and-fips)

networks/calibration/README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
description: >-
33
The calibration network is the most realistic testnet simulation of the
44
Filecoin mainnet.
5+
keywords: "calibration testnet, calibnet, Filecoin testnet, test FIL, faucet, storage provider testing, deal making testnet, 32 GiB sectors, 64 GiB sectors, lotus daemon, bootstrap peers, genesis block, network parameters, WindowPoSt, sector sealing, snapshot, forest snapshot, calibration snapshot, download snapshot"
56
---
67

78
# Calibration
@@ -10,6 +11,49 @@ description: >-
1011
Also see [Calibration RPCs](rpcs.md) and [Calibration Explorers](explorers.md).
1112
{% endhint %}
1213

14+
The calibration network is the most realistic testnet simulation of the Filecoin mainnet.
15+
16+
## Quick Start Commands
17+
18+
### Download Latest Snapshot
19+
```bash
20+
# Fast download with aria2c (recommended)
21+
aria2c -x5 https://forest-archive.chainsafe.dev/latest/calibnet/
22+
23+
# Alternative: wget method
24+
wget https://forest-archive.chainsafe.dev/latest/calibnet/
25+
```
26+
27+
### Connect to Calibration Network
28+
29+
```bash
30+
# Lite node (fastest startup)
31+
FULLNODE_API_INFO=wss://wss.calibration.node.glif.io/apigw/lotus lotus daemon --lite
32+
33+
# Full node with snapshot import
34+
lotus daemon --import-snapshot <calibnet-snapshot-file>
35+
36+
# Connect to RPC endpoint
37+
curl -X POST -H "Content-Type: application/json" -d '{"jsonrpc":"2.0","method":"Filecoin.ChainHead","params":[],"id":1}' https://api.calibration.node.glif.io/rpc/v1
38+
```
39+
40+
### Get Test FIL
41+
42+
Quick access to faucets:
43+
44+
* **Chainsafe**: https://faucet.calibnet.chainsafe-fil.io
45+
* **Zondax**: https://beryx.zondax.ch/faucet/
46+
* **Forest**: https://forest-explorer.chainsafe.dev/faucet/calibnet
47+
48+
### Essential Network Info
49+
50+
* **Chain ID**: `314159` (for MetaMask/wallets)
51+
* **RPC**: `https://api.calibration.node.glif.io/rpc/v1`
52+
* **WebSocket**: `wss://wss.calibration.node.glif.io/apigw/lotus/rpc/v1`
53+
* **Minimum Power**: `32 GiB`
54+
55+
## About Calibration
56+
1357
Prospective storage providers can experience more realistic sealing performance and hardware requirements using final proofs constructions and parameters. Storage clients can store and retrieve _real data_ on the network. Clients can also participate in deal-making workflows and storage and retrieval functionality. The sector size on the Calibration testnet is the same as on the Filecoin mainnet; 32 GiB and 64 GiB sectors are supported. This testnet also includes the Filecoin EVM-runtime features found on the Filecoin mainnet.
1458

1559
Developers can reference pre-existing deals that are already available on the network. See the [`#fil-net-calibration-discuss` channel in the Filecoin Slack](https://filecoinproject.slack.com/archives/C01D42NNLMS) for support.

smart-contracts/filecoin-evm-runtime/how-gas-works.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ description: >-
33
Instead of assigning a fixed gas cost in each instruction, the Filecoin EVM
44
runtime charges FIL gas based on the WASM code execution of the Filecoin EVM
55
runtime interpreter.
6+
keywords: "filecoin gas, gas calculation, gas estimation, gas fees, how gas works, EVM gas"
7+
68
---
79

810
# How gas works
@@ -35,13 +37,13 @@ Let’s take a transaction as an example. Our gas parameters are:
3537
The total fee is `(GasUsage × BaseFee) + (Gaslimit x GasPremium)`:
3638

3739
```plaintext
38-
1000
40+
1000
3941
x 20
4042
= 20000
4143
42-
2000
43-
x 5
44-
= 10000
44+
2000
45+
x 5
46+
= 10000
4547
4648
20000
4749
+ 10000

smart-contracts/fundamentals/support.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ description: >-
88

99
## Slack
1010

11-
Like many other distributed teams, the Filecoin developer relations, lead by the [FIL Builders](https://fil.builders/) team, works mostly on Slack and Discord. You can join the Filecoin Project Slack for free by going to [`filecoin.io/slack`](https://filecoin.io/slack/) and the Discord by going to [https://discord.com/invite/filecoin](https://discord.com/invite/filecoin).
11+
Like many other distributed teams, the Filecoin developer relations, lead by the [FIL Builders](https://fil.builders/) team, works mostly on Slack and Discord. You can join the Filecoin Project Slack for free by going to [`filecoin.io/slack`](https://filecoin.io/slack) and the Discord by going to [https://discord.com/invite/filecoin](https://discord.com/invite/filecoin).
1212

13-
The following Slack channels are most relevant for Filecoin builders:
13+
The following Slack channels are most relevant for Filecoin builders:
1414

1515
* [`#fil-builders`](https://filecoinproject.slack.com/archives/CRK2LKYHW) for building solutions on FVM and Filecoin
1616
* [`#fil-fvm-dev`](https://filecoinproject.slack.com/archives/C029MT4PQB1) for development of the FVM

storage-providers/basics/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ description: >-
33
This page will help you understand how to plan a profitable business, design a
44
suitable storage provider architecture, and make the right hardware
55
investments.
6+
keywords: "earn FIL, Filecoin rewards, storage provider rewards, stake FIL, staking FIL, Filecoin staking, become storage provider, FIL staking alternative"
67
---
78

89
# Basics

0 commit comments

Comments
 (0)