Skip to content

[Docs] Retrieval overview #790

@BigLep

Description

@BigLep

Done Criteria

We have a high-level doc about retrieval in FOC. This should cover or at least have pointers to:

  • Direct SP Piece retrieval
  • Cached SP piece retrieval with FilBeam
  • IPFS retrieval if using tools like filecoin-pin

Why Important

Currently when a user comes to docs.filecoin.cloud and searches for "retriev*" they find https://docs.filecoin.cloud/reference/filoz/synapse-sdk/synapse/interfaces/pieceretriever/, which is API documentation and not giving the user an overview of how retrieval works within FOC.

FOC is intentionally seeking to be different than "Fileocin of the past" by having a solid retrieval story. We need to tell users about it...

User/Customer

Developer wanting to understand how to do retrieval within their FOC-using application.

Notes

  1. I was triggered to create this issue after seeing this user comment: docs: refresh Filecoin Pin landing page and add Getting Started guide filecoin-project/filecoin-docs#2459 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    Status

    🐱 Todo

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions