M3 documentation

[BigLep]

For 2025-10-15

Click to expand

• filecoin-pin Improved/expanded README that covers

  • Goal of filecoin-pin
  • The different "affordances": CLI, opinionated js library
  • Concrete examples: link to example github action, link to filecoin-pin-website
  • Very clear about where to go to get help or ask questions
  • Happening in
    • Initial: Update Filecoin Pin CLI Readme #119 but there is more to do

• filecoin-pin-website README review/refresh

  • docs: improve README and CONTRIBUTING structure and clarity filecoin-pin-website#78

• filecoin-pin/upload-action README review/refresh

  • Update Filecoin Pin Github Action README.md #118

• docs.filecoin.io update with

  • https://docs.filecoin.io/builder-cookbook/filecoin-pin
  • Filecoin Pin CLI
  • Filecoin Pin dApp
  • Filecoin GitHub Action
  • Filecoin Pin FAQ
  • Happening in Filecoin Pin docs: update landing page and add dApp demo and github action example filecoin-docs#2425 and slack thread

• FilOz blog post

  • Being staged in https://docs.google.com/document/d/1MAHKRUcw2_oe3MY_MSzIWAweSjWsCD3X4jRzyslB3eE/edit?tab=t.0
  • https://medium.com/@filoz/announcing-filecoin-pin-new-developer-tools-for-ipfs-pinning-onchain-99b914b90e28

For pin.filecoin.cloud launch

• A page (e.g., filecoin-project/filecoin-pin/documentation/behind-the-scenese-of-adding-a-file.md) that walks through all the steps that occur for adding a file with filecoin-pin. This will be linked to from pin.filecoin.cloud lefthand nav "learn more" button, and should likely be an expansion of the steps listed in https://www.notion.so/filecoindev/pin-filecoin-cloud-website-25bdc41950c180069490d3b5b4518aa8?source=copy_link#285dc41950c18010aa91d3466af7dfdc

• A glossary (e.g., filecoin-project/filecoin-pin/documentation/glossary.md) that outlines all the terms at play. It's expected to be in support of behind-the-scenese-of-adding-a-file.md above.

• Identifying ingress points from docs.ipfs.tech. Basically any place the IPFS docs mention Storacha, we should add a reference to filecoin-pin (caveatign that it is new and actively being improved).

  • https://docs.ipfs.tech/quickstart/pin/#prerequisites
  • https://docs.ipfs.tech/quickstart/pin/#upload-and-pin-a-file
  • https://docs.ipfs.tech/quickstart/pin/#retrieving-with-a-gateway
  • https://docs.ipfs.tech/quickstart/pin/#summary-and-next-steps
  • https://docs.ipfs.tech/quickstart/pin-cli/#prerequisites
  • https://docs.ipfs.tech/quickstart/pin-cli/#upload-and-pin-a-file
  • https://docs.ipfs.tech/quickstart/pin-cli/#retrieving-with-a-gateway
  • https://docs.ipfs.tech/quickstart/pin-cli/#summary-and-next-steps
  • https://docs.ipfs.tech/concepts/persistence/#pinning-services
  • https://docs.ipfs.tech/concepts/persistence/#long-term-storage
  • https://docs.ipfs.tech/how-to/work-with-pinning-services/#use-a-third-party-pinning-service
  • https://docs.ipfs.tech/how-to/best-practices-for-nft-data/#persistence-and-availability

• Specifying the documentation locations for the M3 demo website: M3 website links filecoin-pin-website#29

---

General principles:

• Make it easy for anyone, especially maintainers and those in the working group to contribute or add fixesn - this basically translates into using tools that don't require some other bespoke account setup. Even more, having files in github in the repo is best.
• Substance over appearanance - if time is tight, do markdown files over fancy docs sites
• No wrong/outdated information - it's better to have nothing than something that is wrong

[BigLep]

I started outlining behind-the-scenese-of-adding-a-file.md and glossary.md in https://www.notion.so/filecoindev/Docs-288dc41950c180afbdc9db2b9ef92506 . I'll be active on fill those in 2025-10-14.

[timfong888]

This is the walkthrough demo I did, shortened it alot from @BigLep and @longfei -

https://github.com/timfong888/filecoin-pin-demo/blob/main/DEMO_WALKTHROUGH.md spoke with @jennijuju : this will live on the docs.filecoin.io site in a section determined by @TippyFlitsUK . This will have a plausible URL based on the path.

[TippyFlitsUK]

Staged here - https://filoz.gitbook.io/filoz-filecoin-docs/storage-providers/pdp/developer/filecoin-pin

[timfong888]

Here is my current understanding of the plan:

1. It will be moved to Cookbook > Filecoin Pin, which resides at the bottom. This is in the FilOz GitBook, shown above, but at a different path once moved.
2. @longfei will take over maintenance, update the hand-over process when we are able.
3. Then we will put the content on docs.filecoin.io once it's a clear process of how to make rapid edits and changes.

[timfong888]

Thanks @TippyFlitsUK :

• Staging is now here: https://filoz.gitbook.io/filoz-filecoin-docs/builder-cookbook/filecoin-pin
• Production will follow these docs on docs.filecoin.io (example: https://docs.filecoin.io/builder-cookbook/overview)
• Plausible will be the tracker

Regarding Steve's question for additional content, I am trying to land FAQ that will also be added if done and approved, no action yet for deployment. For now, we are assuming from my side, just the walkthrough README.