M4.x documentation

## For 2025-10-15

Click to expand

- [x] 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: https://github.com/filecoin-project/filecoin-pin/pull/119 but there is more to do

- [x] filecoin-pin-website README review/refresh
- https://github.com/filecoin-project/filecoin-pin-website/pull/78

- [x] filecoin-pin/upload-action README review/refresh
- https://github.com/filecoin-project/filecoin-pin/pull/118

- [x] docs.filecoin.io update with
- [x] https://docs.filecoin.io/builder-cookbook/filecoin-pin
- [x] Filecoin Pin CLI
- [x] Filecoin Pin dApp
- [x] Filecoin GitHub Action
- [x] Filecoin Pin FAQ
- Happening in https://github.com/filecoin-project/filecoin-docs/pull/2425 and [slack thread](https://github.com/filecoin-project/filecoin-docs/pull/2425)

- [x] 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
- [x] 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
- https://github.com/filecoin-project/filecoin-pin/pull/233

- [x] 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.
- https://github.com/filecoin-project/filecoin-pin/pull/233

- [ ] 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

- [x] Specifying the documentation locations for the M3 demo website: https://github.com/filecoin-project/filecoin-pin-website/issues/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