From d71a727066558dacb80c0899611946c270408d6f Mon Sep 17 00:00:00 2001 From: bumblefudge Date: Mon, 4 Nov 2024 23:13:48 +0100 Subject: [PATCH 1/5] rename project-->ecosystem and get started-->installation --- docs/README.md | 2 +- docs/{project => ecosystem}/README.md | 0 docs/{project => ecosystem}/history.md | 0 docs/{project => ecosystem}/related-projects.md | 0 docs/{project => ecosystem}/repository-guide.md | 0 5 files changed, 1 insertion(+), 1 deletion(-) rename docs/{project => ecosystem}/README.md (100%) rename docs/{project => ecosystem}/history.md (100%) rename docs/{project => ecosystem}/related-projects.md (100%) rename docs/{project => ecosystem}/repository-guide.md (100%) diff --git a/docs/README.md b/docs/README.md index e9d58fbca..d2af80622 100644 --- a/docs/README.md +++ b/docs/README.md @@ -57,7 +57,7 @@ Connect your Web2 application to the IPFS network using standard HTTP: - Learn more about the subsystems that IPFS is composed of in [Subsystems and components](./concepts/README.md#subsystems-and-components) - Get an [overview of IPFS implementations](./concepts/ipfs-implementations.md). - [Compare IPFS to other similar systems](./concepts/comparisons.md). -- Understand the project history, ecosystem status and more in the [Project section](./project/README.md). +- Understand the project history, ecosystem status, code governance, and more in the [Ecosystem section](./ecosystem/README.md). - See how other software systems leverage IPFS in the [Case Studies section](./case-studies/arbol.md). ## Join the IPFS community diff --git a/docs/project/README.md b/docs/ecosystem/README.md similarity index 100% rename from docs/project/README.md rename to docs/ecosystem/README.md diff --git a/docs/project/history.md b/docs/ecosystem/history.md similarity index 100% rename from docs/project/history.md rename to docs/ecosystem/history.md diff --git a/docs/project/related-projects.md b/docs/ecosystem/related-projects.md similarity index 100% rename from docs/project/related-projects.md rename to docs/ecosystem/related-projects.md diff --git a/docs/project/repository-guide.md b/docs/ecosystem/repository-guide.md similarity index 100% rename from docs/project/repository-guide.md rename to docs/ecosystem/repository-guide.md From 9d562598222e99643cfb8c45d1ac11d80f171205 Mon Sep 17 00:00:00 2001 From: bumblefudge Date: Mon, 4 Nov 2024 23:29:18 +0100 Subject: [PATCH 2/5] remove Basic Concepts link from Install section --- docs/.vuepress/config.js | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index b2f7b4978..a7c7f34c7 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -80,11 +80,11 @@ module.exports = { }, nav: require('./nav/en'), nav: [ - { text: 'Get Started', link: '/install/' }, { text: 'Concepts', link: '/concepts/' }, + { text: 'Installation', link: '/install/' }, { text: 'Guides', link: '/how-to/' }, { text: 'Reference', link: '/reference/' }, - { text: 'Project', link: '/project/' }, + { text: 'Ecosystem', link: '/ecosystem/' }, { text: 'Case Studies', items: [ {text: 'Arbol', link : '/case-studies/arbol/'}, @@ -99,7 +99,6 @@ module.exports = { sidebar: { '/install/': [ - ['/concepts/what-is-ipfs','Basic Concepts'], { title: 'Quickstart', sidebarDepth: 1, @@ -342,9 +341,9 @@ module.exports = { '/community/contribute/contribution-tutorial' ] }, - '/project/history', - '/project/repository-guide', - '/project/related-projects', + '/ecosystem/history', + '/ecosystem/repository-guide', + '/ecosystem/related-projects', ['https://github.com/ipfs/specs', 'Specifications'], ['/concepts/further-reading/academic-papers', 'Research'], [ @@ -352,7 +351,7 @@ module.exports = { 'Code of conduct' ], ], - '/project/' : [ + '/ecosystem/' : [ ['/community/', 'Join the community'], '/community/contribute/ways-to-contribute', { @@ -366,9 +365,9 @@ module.exports = { '/community/contribute/contribution-tutorial' ] }, - '/project/history', - '/project/repository-guide', - '/project/related-projects', + '/ecosystem/history', + '/ecosystem/repository-guide', + '/ecosystem/related-projects', ['https://github.com/ipfs/specs', 'Specifications'], ['/concepts/further-reading/academic-papers', 'Research'], [ @@ -395,7 +394,7 @@ module.exports = { '/concepts/', '/how-to/', '/reference/', - '/project/', + '/ecosystem/', { title: 'Case Studies', collapsable: true, From 9388498e214c58d78f6456ea9473062b21787fe4 Mon Sep 17 00:00:00 2001 From: bumblefudge Date: Mon, 4 Nov 2024 23:36:35 +0100 Subject: [PATCH 3/5] reorder subcomponents to be easier on first-timers --- docs/.vuepress/config.js | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index a7c7f34c7..7f210fc63 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -166,16 +166,16 @@ module.exports = { collapsable: true, children: [ '/concepts/content-addressing', - '/concepts/bitswap', - '/concepts/dht', - '/concepts/dnslink', '/concepts/file-systems', - '/concepts/ipfs-gateway', - ['https://ipld.io/docs/intro/primer/', 'IPLD (InterPlanetaryLinkedData)' ], + '/concepts/dht', '/concepts/ipni', + ['/concepts/ipfs-gateway', 'Gateways'], + '/concepts/bitswap', + '/concepts/dnslink', '/concepts/ipns', '/concepts/libp2p', '/concepts/merkle-dag' + ['https://ipld.io/docs/intro/primer/', 'IPLD (InterPlanetaryLinkedData)' ], ] }, { From 0f412cc31aaacd89c098dd831870b15ed7be2abc Mon Sep 17 00:00:00 2001 From: bumblefudge Date: Mon, 4 Nov 2024 23:43:13 +0100 Subject: [PATCH 4/5] reorder basic concepts sidenav --- docs/.vuepress/config.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 7f210fc63..b0de12578 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -178,6 +178,8 @@ module.exports = { ['https://ipld.io/docs/intro/primer/', 'IPLD (InterPlanetaryLinkedData)' ], ] }, + ['/concepts/comparisons','IPFS In Comparison'], + '/concepts/cod', { title: 'Implementations', sidebarDepth: 1, @@ -187,9 +189,7 @@ module.exports = { ['/concepts/ipfs-implementations', 'List of implementations'] ] }, - '/concepts/cod', - '/concepts/comparisons', - '/concepts/public-utilities', + ['/concepts/public-utilities','Public Utilities'], ['/concepts/measuring', 'Measuring the network'], '/concepts/faq', '/concepts/glossary', From 4c15cb9f662dcbef38b6037214f983b1f69eb5c8 Mon Sep 17 00:00:00 2001 From: bumblefudge Date: Mon, 4 Nov 2024 23:51:43 +0100 Subject: [PATCH 5/5] lint *.children arrays in config.js --- docs/.vuepress/config.js | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index b0de12578..bcf257045 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -174,7 +174,7 @@ module.exports = { '/concepts/dnslink', '/concepts/ipns', '/concepts/libp2p', - '/concepts/merkle-dag' + '/concepts/merkle-dag', ['https://ipld.io/docs/intro/primer/', 'IPLD (InterPlanetaryLinkedData)' ], ] }, @@ -186,14 +186,14 @@ module.exports = { collapsable: true, children: [ ['/concepts/implementations', 'Implementations explained'], - ['/concepts/ipfs-implementations', 'List of implementations'] + ['/concepts/ipfs-implementations', 'List of implementations'], ] }, ['/concepts/public-utilities','Public Utilities'], ['/concepts/measuring', 'Measuring the network'], '/concepts/faq', '/concepts/glossary', - '/concepts/further-reading/academic-papers' + '/concepts/further-reading/academic-papers', ], '/how-to/': [ '/how-to/desktop-app', @@ -237,7 +237,7 @@ module.exports = { collapsable: true, children: [ '/how-to/observe-peers', - '/how-to/peering-with-content-providers' + '/how-to/peering-with-content-providers', ] }, { @@ -250,7 +250,7 @@ module.exports = { '/how-to/websites-on-ipfs/link-a-domain', '/how-to/websites-on-ipfs/introducing-fleek', '/how-to/websites-on-ipfs/static-site-generators', - '/how-to/websites-on-ipfs/redirects-and-custom-404s' + '/how-to/websites-on-ipfs/redirects-and-custom-404s', ] }, { @@ -259,7 +259,7 @@ module.exports = { collapsable: true, children: [ '/how-to/address-ipfs-on-web', - '/how-to/browser-tools-frameworks' + '/how-to/browser-tools-frameworks', ] }, { @@ -267,7 +267,7 @@ module.exports = { sidebarDepth: 1, collapsable: true, children: [ - '/how-to/publish-ipns' + '/how-to/publish-ipns', ] }, { @@ -276,7 +276,7 @@ module.exports = { collapsable: true, children: [ '/how-to/gateway-best-practices', - '/how-to/gateway-troubleshooting' + '/how-to/gateway-troubleshooting', ] }, { @@ -287,7 +287,7 @@ module.exports = { '/how-to/companion-node-types', '/how-to/dnslink-companion', '/how-to/companion-window-ipfs', - '/how-to/companion-x-ipfs-path-header' + '/how-to/companion-x-ipfs-path-header', ] }, { @@ -295,7 +295,7 @@ module.exports = { sidebarDepth: 1, collapsable: true, children: [ - '/how-to/best-practices-for-nft-data' + '/how-to/best-practices-for-nft-data', ] }, { @@ -338,7 +338,7 @@ module.exports = { '/community/contribute/grammar-formatting-and-style', '/community/contribute/writing-guide', '/community/contribute/code-persona', - '/community/contribute/contribution-tutorial' + '/community/contribute/contribution-tutorial', ] }, '/ecosystem/history', @@ -362,7 +362,7 @@ module.exports = { '/community/contribute/grammar-formatting-and-style', '/community/contribute/writing-guide', '/community/contribute/code-persona', - '/community/contribute/contribution-tutorial' + '/community/contribute/contribution-tutorial', ] }, '/ecosystem/history', @@ -372,7 +372,7 @@ module.exports = { ['/concepts/further-reading/academic-papers', 'Research'], [ 'https://github.com/ipfs/community/blob/master/code-of-conduct.md', - 'Code of conduct' + 'Code of conduct', ], ], '/case-studies/' : [ @@ -385,7 +385,7 @@ module.exports = { ['/case-studies/fleek', 'Fleek'], ['/case-studies/likecoin', 'LikeCoin'], ['/case-studies/morpheus', 'Morpheus.Network'], - ['/case-studies/snapshot', 'Snapshot'] + ['/case-studies/snapshot', 'Snapshot'], ] } ], @@ -404,7 +404,7 @@ module.exports = { ['/case-studies/fleek', 'Fleek'], ['/case-studies/likecoin', 'LikeCoin'], ['/case-studies/morpheus', 'Morpheus.Network'], - ['/case-studies/snapshot', 'Snapshot'] + ['/case-studies/snapshot', 'Snapshot'], ] }, ]