Skip to content

Commit 77a4b18

Browse files
authored
Merge pull request #384 from scroll-tech/scroll-sdk
feat: Adds SDK documentation
2 parents c3b2eb2 + 16e4100 commit 77a4b18

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+4934
-5
lines changed

public/locales/en/translation.json

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -118,32 +118,27 @@
118118
"scrollArchitecture": "Scroll Architecture",
119119
"scrollUpgrades": "Scroll Upgrades",
120120
"overview": "Overview",
121-
122121
"scrollChain": "Scroll Chain",
123122
"accountsAndState": "Accounts and State",
124123
"blocks": "Blocks",
125124
"transactions": "Transactions",
126125
"rollupProcess": "Rollup Process",
127126
"evmDifferencesFromEthereum": "EVM Differences from Ethereum",
128-
129127
"bridge": "Bridge",
130128
"crossDomainMessaging": "Cross-Domain Messaging",
131129
"depositGateways": "Deposit Gateways",
132130
"withdrawGateways": "Withdraw Gateways",
133-
134131
"sequencer": "Sequencer",
135132
"executionNode": "Execution Node",
136133
"rollupNode": "Rollup Node",
137134
"zkTrie": "zkTrie",
138-
139135
"zkevm": "zkEVM",
140136
"introToZkevm": "Intro to zkEVM",
141137
"zkevmOverview": "zkEVM Overview",
142138
"bridgeOverview": "Bridge Overview",
143139
"prover": "Prover",
144140
"proofGeneration": "Proof Generation",
145141
"cpuProverRepo": "CPU Prover Repo",
146-
147142
"security": "Security",
148143
"auditsAndBugBounty": "Audits & Bug Bounty",
149144
"l2BeatAssessment": "L2Beat Assessment"
@@ -157,6 +152,30 @@
157152
"polynomialCommitmentSchemes": "Polynomial Commitment Schemes",
158153
"kzgCommitmentScheme": "KZG Commitment Scheme",
159154
"additionalResources": "Additional Resources"
155+
},
156+
"sdk": {
157+
"overview": "Overview",
158+
"scrollSdk": "Scroll SDK Introduction",
159+
"faq": "Scroll SDK FAQ",
160+
"technicalStack": "Technical Stack",
161+
"stackOverview": "Stack Overview",
162+
"configuration": "Configuration",
163+
"services": "Services",
164+
"smartContracts": "Smart Contracts",
165+
"proofGeneration": "Proof Generation",
166+
"integrations": "Integrations",
167+
"guides": "Guides",
168+
"devnetDeployment": "Devnet Deployment",
169+
"productionDeployment": "Production Deployment",
170+
"digitalOcean": "Digital Ocean & ERC20 Gas Token Testnet",
171+
"customizingSdkComponents": "Customizing SDK Components",
172+
"awsDeployment": "AWS Deployment",
173+
"operation": "Operating a Chain",
174+
"gasAndFees": "Gas & Fee Management",
175+
"monitoring": "Monitoring",
176+
"security": "Security and Recovery",
177+
"upgrades": "Upgrading",
178+
"troubleshooting": "Troubleshooting"
160179
}
161180
},
162181
"footer": {

src/assets/svgs/home/home-sdk.svg

Lines changed: 3 additions & 0 deletions
Loading

src/config/menu.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ export const MENU: MenuItems = {
1616
{ text: "Developers", link: "/en/developers", section: "developers" },
1717
{ text: "Technology", link: "/en/technology", section: "technology" },
1818
{ text: "Learn", link: "/en/learn", section: "learn" },
19+
{ text: "SDK", link: "/en/sdk", section: "sdk" },
1920
],
2021
zh: [
2122
{

src/config/sidebar.ts

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -340,5 +340,99 @@ export const getSidebar = () => {
340340
],
341341
},
342342
],
343+
sdk: [
344+
{
345+
section: t("sidebar.sdk.overview"),
346+
contents: [
347+
{
348+
title: t("sidebar.sdk.scrollSdk"),
349+
url: "sdk/",
350+
},
351+
{
352+
title: t("sidebar.sdk.faq"),
353+
url: "sdk/sdk-faq",
354+
},
355+
],
356+
},
357+
{
358+
section: t("sidebar.sdk.technicalStack"),
359+
contents: [
360+
{
361+
title: t("sidebar.sdk.stackOverview"),
362+
url: formatUrl("sdk/technical-stack/"),
363+
},
364+
{
365+
title: t("sidebar.sdk.configuration"),
366+
url: formatUrl("sdk/technical-stack/configuration"),
367+
},
368+
{
369+
title: t("sidebar.sdk.services"),
370+
url: formatUrl("sdk/technical-stack/services"),
371+
},
372+
{
373+
title: t("sidebar.sdk.smartContracts"),
374+
url: formatUrl("sdk/technical-stack/contracts"),
375+
},
376+
{
377+
title: t("sidebar.sdk.proofGeneration"),
378+
url: formatUrl("sdk/technical-stack/proof-generation"),
379+
},
380+
{
381+
title: t("sidebar.sdk.integrations"),
382+
url: formatUrl("sdk/technical-stack/integrations"),
383+
},
384+
],
385+
},
386+
{
387+
section: t("sidebar.sdk.guides"),
388+
contents: [
389+
{
390+
title: t("sidebar.sdk.devnetDeployment"),
391+
url: formatUrl("sdk/guides/devnet-deployment"),
392+
},
393+
// {
394+
// title: t("sidebar.sdk.productionDeployment"),
395+
// url: formatUrl("sdk/guides/production-deployment"),
396+
// },
397+
{
398+
title: t("sidebar.sdk.digitalOcean"),
399+
url: formatUrl("sdk/guides/digital-ocean-alt-gas-token"),
400+
},
401+
{
402+
title: t("sidebar.sdk.awsDeployment"),
403+
url: formatUrl("sdk/guides/aws-deployment"),
404+
},
405+
{
406+
title: t("sidebar.sdk.customizingSdkComponents"),
407+
url: formatUrl("sdk/guides/customizing-sdk-components"),
408+
},
409+
],
410+
},
411+
{
412+
section: t("sidebar.sdk.operation"),
413+
contents: [
414+
{
415+
title: t("sidebar.sdk.gasAndFees"),
416+
url: formatUrl("sdk/operation/gas-and-fees"),
417+
},
418+
{
419+
title: t("sidebar.sdk.monitoring"),
420+
url: formatUrl("sdk/operation/monitoring"),
421+
},
422+
{
423+
title: t("sidebar.sdk.upgrades"),
424+
url: formatUrl("sdk/operation/upgrades"),
425+
},
426+
{
427+
title: t("sidebar.sdk.troubleshooting"),
428+
url: formatUrl("sdk/operation/troubleshooting"),
429+
},
430+
{
431+
title: t("sidebar.sdk.security"),
432+
url: formatUrl("sdk/operation/security-and-recovery"),
433+
},
434+
],
435+
},
436+
],
343437
}
344438
}
Loading
Loading
Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)