Skip to content

Commit ba2e5eb

Browse files
authored
Merge pull request #483 from nomiclabs/tutorial
Add Buidler Tutorial for beginners
2 parents 82f5cf5 + 8701014 commit ba2e5eb

File tree

24 files changed

+1842
-57
lines changed

24 files changed

+1842
-57
lines changed

Diff for: docs/.vuepress/config.js

+73-51
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ module.exports = {
2222
{ text: "Buidler EVM", link: "/buidler-evm/" },
2323
{ text: "Plugins", link: "/plugins/" },
2424
{ text: "Documentation", link: "/getting-started/" },
25+
{ text: "Tutorial", link: "/tutorial/" },
2526
{ text: "API", link: "/api/" }
2627
],
2728
lastUpdated: true,
@@ -32,57 +33,78 @@ module.exports = {
3233
editLinks: true,
3334
sidebarDepth: 1,
3435
displayAllHeaders: true,
35-
sidebar: [
36-
["/getting-started/", "Getting Started", 1],
37-
["/config/", "Configuration", 0],
38-
["/buidler-evm/", "Buidler EVM", 0],
39-
{
40-
title: "Guides",
41-
url: "/guides/",
42-
collapsable: false,
43-
depth: 1,
44-
children: [
45-
["/guides/truffle-migration.md", "Migrating from Truffle", 0],
46-
["/guides/project-setup.md", "Setting up a project", 0],
47-
["/guides/compile-contracts.md", "Compiling your contracts", 0],
48-
["/guides/truffle-testing.md", "Testing with Web3.js & Truffle", 0],
49-
["/guides/waffle-testing.md", "Testing with ethers.js & Waffle", 0],
50-
["/guides/deploying.md", "Deploying your contracts", 0],
51-
["/guides/scripts.md", "Writing scripts", 0],
52-
["/guides/buidler-console.md", "Using the Buidler console", 0],
53-
["/guides/create-task.md", "Creating a task", 0],
54-
["/guides/ganache-tests.md", "Running tests with Ganache", 0],
55-
["/guides/vscode-tests.md", "Running tests on VS Code", 0],
56-
["/guides/typescript.md", "TypeScript support", 0]
57-
]
58-
},
59-
{
60-
title: "Advanced",
61-
collapsable: false,
62-
children: [
63-
[
64-
"/advanced/buidler-runtime-environment.html",
65-
"Buidler Runtime Environment (BRE)",
66-
0
67-
],
68-
["/advanced/building-plugins.html", "Building plugins", 0]
69-
]
70-
},
71-
{
72-
title: "Troubleshooting",
73-
collapsable: false,
74-
children: [
75-
["/troubleshooting/verbose-logging.html", "Verbose logging", 0],
76-
["/troubleshooting/common-problems.html", "Common problems", 0],
77-
["/errors/", "Error codes", 0]
78-
]
79-
},
80-
{
81-
title: "Plugins",
82-
collapsable: false,
83-
children: pluginsChildren
84-
}
85-
]
36+
sidebar: {
37+
'/tutorial/': [
38+
{
39+
title: "Tutorial",
40+
url: "1-setup/",
41+
collapsable: false,
42+
depth: 1,
43+
children: [
44+
["", "1. Overview", 1],
45+
["2-setup/", "2. Setting up the environment", 0],
46+
["3-config/", "3. Creating a new Buidler project", 0],
47+
["4-contracts/", "4. Writing and compiling contracts", 0],
48+
["5-test/", "5. Testing contracts", 0],
49+
["6-debug/", "6. Debugging with Buidler EVM", 0],
50+
["7-deploy/", "7. Deploying to a live network", 0],
51+
["boilerplate/", "8. Hackathon Boilerplate Project", 0],
52+
["9-final-thoughts/", "9. Final thoughts", 0],
53+
]
54+
},
55+
],
56+
'/': [
57+
["/getting-started/", "Getting Started", 1],
58+
["/config/", "Configuration", 0],
59+
["/buidler-evm/", "Buidler EVM", 0],
60+
{
61+
title: "Guides",
62+
url: "/guides/",
63+
collapsable: false,
64+
depth: 1,
65+
children: [
66+
["/guides/truffle-migration.md", "Migrating from Truffle", 0],
67+
["/guides/project-setup.md", "Setting up a project", 0],
68+
["/guides/compile-contracts.md", "Compiling your contracts", 0],
69+
["/guides/truffle-testing.md", "Testing with Web3.js & Truffle", 0],
70+
["/guides/waffle-testing.md", "Testing with ethers.js & Waffle", 0],
71+
["/guides/deploying.md", "Deploying your contracts", 0],
72+
["/guides/scripts.md", "Writing scripts", 0],
73+
["/guides/buidler-console.md", "Using the Buidler console", 0],
74+
["/guides/create-task.md", "Creating a task", 0],
75+
["/guides/ganache-tests.md", "Running tests with Ganache", 0],
76+
["/guides/vscode-tests.md", "Running tests on VS Code", 0],
77+
["/guides/typescript.md", "TypeScript support", 0]
78+
]
79+
},
80+
{
81+
title: "Advanced",
82+
collapsable: false,
83+
children: [
84+
[
85+
"/advanced/buidler-runtime-environment.html",
86+
"Buidler Runtime Environment (BRE)",
87+
0
88+
],
89+
["/advanced/building-plugins.html", "Building plugins", 0]
90+
]
91+
},
92+
{
93+
title: "Troubleshooting",
94+
collapsable: false,
95+
children: [
96+
["/troubleshooting/verbose-logging.html", "Verbose logging", 0],
97+
["/troubleshooting/common-problems.html", "Common problems", 0],
98+
["/errors/", "Error codes", 0]
99+
]
100+
},
101+
{
102+
title: "Plugins",
103+
collapsable: false,
104+
children: pluginsChildren
105+
}
106+
]
107+
}
86108
},
87109
head: [
88110
[

0 commit comments

Comments
 (0)