Skip to content

Revamp the "Build" section. #252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 43 commits into from
Closed
Show file tree
Hide file tree
Changes from 42 commits
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
62c61a9
Pulls tutorial into single file.
johnnymatthews Aug 12, 2020
89a97f1
Changes Examples to Tutorials.
johnnymatthews Aug 12, 2020
750557d
Removes Sample Architecture page.
johnnymatthews Aug 12, 2020
ede1135
Adds Textile Hub section.
johnnymatthews Aug 12, 2020
9eb0fe1
Adds temp redirect file.
johnnymatthews Aug 12, 2020
6ba78bf
Fixes type formatting.
johnnymatthews Aug 12, 2020
a152686
Fixes links.
johnnymatthews Aug 12, 2020
1bdfcb1
Moves "Network inspector" tutorial into single page.
johnnymatthews Aug 12, 2020
68d31c0
Moves tutorial into single page.
johnnymatthews Aug 12, 2020
a3f7e55
Fixes links.
johnnymatthews Aug 12, 2020
54a27cd
Fixes links.
johnnymatthews Aug 12, 2020
ce8372b
Fixes links.
johnnymatthews Aug 12, 2020
bc0d64e
Changes headers to sentence case.
johnnymatthews Aug 12, 2020
0b1a14f
Moves Slate and Powergate to better position.
johnnymatthews Aug 12, 2020
29bfe02
Adds Slate and Powergate redirect.
johnnymatthews Aug 12, 2020
1b771c6
Adds further network info and fixes issues.
johnnymatthews Aug 13, 2020
5409632
Adds networks to redirects.
johnnymatthews Aug 13, 2020
a36e9f7
Placeholder info for build.
johnnymatthews Aug 13, 2020
0f10ecc
Renames section to network.
johnnymatthews Aug 13, 2020
827bdce
Adds local networks.
johnnymatthews Aug 13, 2020
2f4d344
Fixes spelling and grammar.
johnnymatthews Aug 13, 2020
3822858
Fixes links.
johnnymatthews Aug 13, 2020
39a1cad
Fixes links.
johnnymatthews Aug 13, 2020
ebea42f
Replaces FPS with FIPS.
johnnymatthews Aug 14, 2020
76920af
Created tools section, moved things around.
johnnymatthews Aug 14, 2020
95bd8e9
Adds tools section to sidebar.
johnnymatthews Aug 14, 2020
c7f7874
Adds placeholder info for Getting started.
johnnymatthews Aug 14, 2020
0aba557
Changes h2 title.
johnnymatthews Aug 14, 2020
9332f9b
Adds Tools section redirects.
johnnymatthews Aug 14, 2020
f29aa39
Renames FIPS file.
johnnymatthews Aug 14, 2020
96ec6a1
Adds placeholder info for landing page.
johnnymatthews Aug 14, 2020
20197be
Renames FBP sevice.
johnnymatthews Aug 14, 2020
95d3ad3
Fixes links.
johnnymatthews Aug 14, 2020
abbbc29
Fixes links.
johnnymatthews Aug 14, 2020
d7fc42f
Fixes broken image.
johnnymatthews Aug 14, 2020
b34208d
Fixes sidebar nav and vuepress build error.
johnnymatthews Aug 14, 2020
622e649
Fixing relative links.
johnnymatthews Aug 17, 2020
97f7763
Fixes relative links.
johnnymatthews Aug 17, 2020
2665816
Merge branch 'master' into feat/revamping-build-section
johnnymatthews Aug 20, 2020
039e830
Removes /build/networks. Dupe of /how-tos/networks
johnnymatthews Aug 20, 2020
3287687
Sorts old content into new sidebar.
johnnymatthews Aug 20, 2020
cd883cf
Fixes link.
johnnymatthews Aug 20, 2020
bbe1e72
Moves icons onto separate lines.
johnnymatthews Aug 25, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
85 changes: 16 additions & 69 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -76,84 +76,31 @@ module.exports = {
'/mine/mining-troubleshooting'
],
'/build/': [
'/build/getting-started',
'/build/implementations',
{
title: 'Start Building',
title: 'Tools',
collapsable: false,
path: '/build/start-building/interacting-with-the-network/',
children: ['start-building/interacting-with-the-network']
},
{
title: 'Core Products',
collapsable: false,
path: '/build/core-products/filecoin-backed-pinning-services/',
path: '/build/tools/',
children: [
'core-products/filecoin-backed-pinning-services',
'core-products/powergate',
'core-products/protocol-implementations'
'/build/tools/api-clients',
'/build/tools/filecoin-backed-pinning',
'/build/tools/powergate',
'/build/tools/signing-libraries',
'/build/tools/slate',
'/build/tools/wallets'
]
},
{
title: 'Developer Tools',
collapsable: false,
path: '/build/developer-tools/wallets-signing-tools-api-clients/',
children: [
'developer-tools/wallets-signing-tools-api-clients',
[
'https://github.com/filecoin-project/docs/wiki#community-resources',
'Filecoin Community Resources'
],
['http://filecoin.onrender.com/', 'Component Design System']
]
},
{
title: 'Example Apps',
title: 'Examples',
sidebarDepth: 2,
path: '/build/examples/sample-architectures/',
path: '/build/examples/',
collapsable: false,
children: [
'examples/sample-architectures',
['examples/web-applications/overview', 'Web Applications'],
{
title: 'Simple Pinning Service',
path: '/build/examples/simple-pinning-service/overview/',
children: [
'/build/examples/simple-pinning-service/powergate-lotus-go-ipfs-interactions',
'/build/examples/simple-pinning-service/step-1-powergate-setup',
'/build/examples/simple-pinning-service/step-2-react-app-setup',
'/build/examples/simple-pinning-service/step-3-connecting-powergate-to-app',
'/build/examples/simple-pinning-service/step-4-explore-pinning-service-app',
'/build/examples/simple-pinning-service/step-5-shut-down-the-application',
'/build/examples/simple-pinning-service/summary'
]
},
{
title: 'Network Inspector',
path: '/build/examples/network-inspector/overview/',
children: [
'/build/examples/network-inspector/lotus-and-go-ipfs-interactions',
'/build/examples/network-inspector/step-1-start-lotus-devnet-and-go-ipfs',
'/build/examples/network-inspector/step-2-run-the-react-app',
'/build/examples/network-inspector/step-3-set-up-the-lotus-and-go-ipfs-api-clients',
'/build/examples/network-inspector/step-4-explore-the-filecoin-network-inspector-app',
'/build/examples/network-inspector/step-5-shut-down-the-application',
'/build/examples/network-inspector/summary'
]
},
{
title: 'Meme Marketplace',
path: '/build/examples/meme-marketplace/overview/',
children: [
'/build/examples/meme-marketplace/textile-hub-buckets-and-erc721',
'/build/examples/meme-marketplace/step-1-blockchain-and-contracts-setup',
'/build/examples/meme-marketplace/step-2-run-react-app',
'/build/examples/meme-marketplace/step-3-run-hub-auth-server',
'/build/examples/meme-marketplace/step-4-connecting-app-with-auth-server',
'/build/examples/meme-marketplace/step-5-connecting-app-with-blockchain',
'/build/examples/meme-marketplace/step-6-explore-app',
'/build/examples/meme-marketplace/step-7-shut-down-the-application',
'/build/examples/meme-marketplace/summary'
]
}
'/build/examples/meme-marketplace',
'/build/examples/network-inspector',
'/build/examples/simple-pinning-service',
'/build/examples/slate-and-powergate'
]
}
],
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,5 +13,5 @@ Available storage and pricing is not controlled by any single company. Instead,

There are many ways to participate in the Filecoin network, and several libraries, tools, products, and services to choose from:

- If you're new to web3 and Filecoin, we recommend checking out the resources in [this guide](/introduction/new-to-web3.md).
- If you're new to web3 and Filecoin, we recommend checking out the resources in [this guide](./introduction/new-to-web3.md).
- If you're a developer looking to get started building on Filecoin, check out the [Build section](./build/README.md).
34 changes: 11 additions & 23 deletions docs/build/README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,20 @@
---
title: Build
description: A guide to getting started with building applications on Filecoin.
description: Design, create, and build applications on the Filecoin network with IPFS, Slate's React component library, and Textile's Powergate.
---

# Build

Filecoin is for the builders. If you are excited about the potential of leveraging the Filecoin protocol and decentralized storage network to build game-changing applications, you’ve come to the right place. In this section, you will find some helpful resources as you get started building applications on Filecoin.
Design, create, and build applications on the Filecoin network with IPFS, Slate's React component library, and Textile's Powergate.

Read the resources in the **Start Building** section before you begin for helpful pointers on application architecture and networks to use when interacting and testing with Filecoin.
<!--

- [Interacting with the network](./start-building/interacting-with-the-network.md)
- Who should use this section
- What this section contains
Handy tools
Workflows
Examples and tutorials
Getting started section
Call out for miners who are in the wrong place.

**Core Products** gives you an overview of the three main categories of products that we recommend to developers, and high-level pointers on how to run and integrate them in your application.

- **For most developers**, we recommend getting started with [Filecoin-backed IPFS Pinning Services](./core-products/filecoin-backed-pinning-services.md). This is especially true if you’re coming to Filecoin from IPFS or other web3 ecosystems.
- **For some developers who want to manage their own nodes**, we recommend using [Powergate](./core-products/powergate.md).
- **For very advanced, protocol-level developers**, we recommend using [Filecoin protocol implementations](./core-products/protocol-implementations.md), e.g. [lotus](https://lotu.sh).

**Developer Tools** provides brief descriptions and links to tools and libraries that provide important functionality for application developers.

- [Wallets, signing tools, and API clients](./developer-tools/wallets-signing-tools-api-clients.md) and [Filecoin Community Resources](https://github.com/filecoin-project/docs/wiki#community-resources) will direct you to various resources you can use in your applications
- The Filecoin [Component Design System](http://filecoin.onrender.com/) is a design system that includes Filecoin-branded web UI components and tutorials that you can integrate into your application.

**Examples** includes end-to-end code examples, tutorials, and walkthroughs for applications built on Filecoin. The examples section currently features:

- [Meme Marketplace](./examples/meme-marketplace/overview.md): An example application built on Textile Hub, a Filecoin-backed IPFS Pinning Service.
- [Simple Pinning Service](./examples/simple-pinning-service/overview.md): An example application built on Powergate.
- [Slate](./examples/slate/overview.md): A production application built on Powergate.
- [Network Inspector](./examples/network-inspector/overview.md): An example application built on lotus.

Please suggest any additional content that you would find useful using the links below.
-->
29 changes: 0 additions & 29 deletions docs/build/developer-tools/wallets-signing-tools-api-clients.md

This file was deleted.

Loading