docs: refresh information architecture, onboarding, and navigation#2457
Draft
snissn wants to merge 10 commits intofilecoin-project:mainfrom
Draft
docs: refresh information architecture, onboarding, and navigation#2457snissn wants to merge 10 commits intofilecoin-project:mainfrom
snissn wants to merge 10 commits intofilecoin-project:mainfrom
Conversation
…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.
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
2 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