docs: refresh information architecture, onboarding, and navigation#60
Draft
snissn wants to merge 67 commits into
Draft
docs: refresh information architecture, onboarding, and navigation#60snissn wants to merge 67 commits into
snissn wants to merge 67 commits into
Conversation
✅ Deploy Preview for timely-kataifi-9f3a09 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
snissn
changed the title
…path guides Standardize 18 section READMEs as TOC pages with consistent format. Author Filecoin Onchain Cloud overview with FWSS, PDP, Filecoin Pay, and Synapse SDK. Create PDP About page with protocol explanation. Refine upload-to-filecoin and build/getting-started as conceptual guides with external refs. Remove 4 orphaned files, update redirects.
Add a comprehensive GitBook documentation section covering content structure, frontmatter fields, internal links, and custom blocks (hints, tabs, cards, code blocks). Fix incorrect IPLD repository link (was pointing to libp2p). Clean up trailing whitespace, normalize list markers to asterisks, and fix Filecoin capitalization.
…kbook Re-import the filecoin-pin cookbook (README, CLI guide, dApp demo, GitHub Action, FAQ, ERC-8004 agent registration guide, and assets) under build/cookbook/filecoin-pin/ in their formatted form, and register the section in .gitbook.yaml redirects so prior URLs continue to resolve.
…lecoin.io links - Add Filecoin Pin section and pages to SUMMARY.md and link it from the cookbook landing page. - Replace https://docs.filecoin.io/* internal references with relative markdown paths across the glossary, protocol API, lotus components, and slashing-related pages, so the docs quality link-checker stops flagging them.
…n-restore docs(cookbook): restore filecoin-pin and wire up navigation
Refs filecoin-project/filecoin-pin#444 - Flip landing page from alpha/calibration to production-ready on mainnet - Broaden audience framing to include Storacha, Pinata, other pinning users - Add new Getting Started page with end-to-end onboarding flow - Add Getting Started to sidebar as first Filecoin Pin subpage Existing CLI page intentionally retained for side-by-side preview comparison; will be refreshed in a follow-up.
Per review feedback in filecoin-project#444 thread: - Add "Inspect your storage proofs" section to Getting Started covering filecoin-pin data-set --ls and data-set <id> (per Jen's request to preserve the prove-storage content from the old CLI page). - Delete builder-cookbook/filecoin-pin/filecoin-pin-cli.md. - Drop the CLI page entry from SUMMARY.md. - Drop the CLI page item from the Filecoin Pin landing list. - Update ERC-8004 page references to point at Getting Started.
…in-project#2461) * docs(filecoin-pin): mainnet GA updates and PR review feedback - getting-started: Node.js 22 → 24, IPFS standard tooling wording, unique demo file content with date, store vs upload wording, IPNI link, multiple times per day proofs, add behind-the-scenes link - faq: reframe for mainnet-first; update "How can I use today?" and "How long is my data stored?" to lead with Mainnet - erc-8004: use relative link for Getting Started; drop invalid --mainnet flags (mainnet is default) - dapp-demo: Node.js 18+ → 24+; fix broken #support-info anchor and typo "communcation" Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs(filecoin-pin): address PR review feedback - "via IPFS standard tooling" -> "using standard IPFS tooling" - Revert "multiple times per day" -> "daily" for proof frequency - Update erc-8004 Getting Started reference: testnet tokens -> FIL/USDFC to match the current mainnet-focused Getting Started guide Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Update RPC guidance
Remove the "ALPHA FEATURE - UNDER DEVELOPMENT" danger hint blocks from the PDP landing page and the Install & Run PDP guide, including the Synapse SDK production pointer they contained.
docs(build): refresh framework verification examples
docs(build): refresh Filecoin.sol examples
docs(build): refresh advanced examples
…-alpha-alerts docs(pdp): remove alpha feature warnings from PDP section
* docs(storage): refresh store and retrieval examples * docs(storage): address retrieval review notes * docs(storage): swap Storacha for fil.one and Pinata in storage lists --------- Co-authored-by: nijoe1 <nick@fil.builders>
* docs: address BigLep's review feedback (GER-1011) Resolve the high/medium items from BigLep's review of filecoin-project#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.
docs: add Filecoin Onchain Cloud subsection
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This is a clean rebuild of the intended docs information architecture changes on top of current upstream
main. Most of the diff is structural moves, regrouping, and redirects, with a smaller set of targeted onboarding and cleanup updates.Key changes
Reorganize the docs around clearer entry points
Getting Started,Core Concepts,Networks & Tools,Provide Storage,Build on Filecoin, andReference.Improve onboarding and current recommended paths
build/getting-started.mdandgetting-started/how-storage-works/upload-to-filecoin.mdto give clearer starting points for builders and storage users.Consolidate retired material and align terminology
legacy/README.md.SkillstoCore CompetenciesandDeprecated networkstoLegacy networks.reference/general/moved-content.mdas a pointer for content that now lives elsewhere.Keep navigation and redirects in sync
SUMMARY.mdand.gitbook.yamlto match the new structure and preserve moved URLs.secure_pathsudo snippet.How to review
Review commit-by-commit. The branch is split into six focused commits so structure, legacy consolidation, onboarding, navigation, and cleanup can be audited separately:
docs(ia): move content into updated top-level sectionsdocs(legacy): consolidate archived and retired contentdocs(onboarding): add new getting-started and upload guidancedocs(terms): align terminology and section namesdocs(nav): update summary and redirects for the new IAdocs(cleanup): apply final link, wording, and formatting fixesValidation
npm run build