Skip to content

Commit

Permalink
Merge pull request #384 from scroll-tech/scroll-sdk
Browse files Browse the repository at this point in the history
feat: Adds SDK documentation
  • Loading branch information
dghelm authored Oct 31, 2024
2 parents c3b2eb2 + 16e4100 commit 77a4b18
Show file tree
Hide file tree
Showing 51 changed files with 4,934 additions and 5 deletions.
29 changes: 24 additions & 5 deletions public/locales/en/translation.json
Original file line number Diff line number Diff line change
Expand Up @@ -118,32 +118,27 @@
"scrollArchitecture": "Scroll Architecture",
"scrollUpgrades": "Scroll Upgrades",
"overview": "Overview",

"scrollChain": "Scroll Chain",
"accountsAndState": "Accounts and State",
"blocks": "Blocks",
"transactions": "Transactions",
"rollupProcess": "Rollup Process",
"evmDifferencesFromEthereum": "EVM Differences from Ethereum",

"bridge": "Bridge",
"crossDomainMessaging": "Cross-Domain Messaging",
"depositGateways": "Deposit Gateways",
"withdrawGateways": "Withdraw Gateways",

"sequencer": "Sequencer",
"executionNode": "Execution Node",
"rollupNode": "Rollup Node",
"zkTrie": "zkTrie",

"zkevm": "zkEVM",
"introToZkevm": "Intro to zkEVM",
"zkevmOverview": "zkEVM Overview",
"bridgeOverview": "Bridge Overview",
"prover": "Prover",
"proofGeneration": "Proof Generation",
"cpuProverRepo": "CPU Prover Repo",

"security": "Security",
"auditsAndBugBounty": "Audits & Bug Bounty",
"l2BeatAssessment": "L2Beat Assessment"
Expand All @@ -157,6 +152,30 @@
"polynomialCommitmentSchemes": "Polynomial Commitment Schemes",
"kzgCommitmentScheme": "KZG Commitment Scheme",
"additionalResources": "Additional Resources"
},
"sdk": {
"overview": "Overview",
"scrollSdk": "Scroll SDK Introduction",
"faq": "Scroll SDK FAQ",
"technicalStack": "Technical Stack",
"stackOverview": "Stack Overview",
"configuration": "Configuration",
"services": "Services",
"smartContracts": "Smart Contracts",
"proofGeneration": "Proof Generation",
"integrations": "Integrations",
"guides": "Guides",
"devnetDeployment": "Devnet Deployment",
"productionDeployment": "Production Deployment",
"digitalOcean": "Digital Ocean & ERC20 Gas Token Testnet",
"customizingSdkComponents": "Customizing SDK Components",
"awsDeployment": "AWS Deployment",
"operation": "Operating a Chain",
"gasAndFees": "Gas & Fee Management",
"monitoring": "Monitoring",
"security": "Security and Recovery",
"upgrades": "Upgrading",
"troubleshooting": "Troubleshooting"
}
},
"footer": {
Expand Down
3 changes: 3 additions & 0 deletions src/assets/svgs/home/home-sdk.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions src/config/menu.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ export const MENU: MenuItems = {
{ text: "Developers", link: "/en/developers", section: "developers" },
{ text: "Technology", link: "/en/technology", section: "technology" },
{ text: "Learn", link: "/en/learn", section: "learn" },
{ text: "SDK", link: "/en/sdk", section: "sdk" },
],
zh: [
{
Expand Down
94 changes: 94 additions & 0 deletions src/config/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -340,5 +340,99 @@ export const getSidebar = () => {
],
},
],
sdk: [
{
section: t("sidebar.sdk.overview"),
contents: [
{
title: t("sidebar.sdk.scrollSdk"),
url: "sdk/",
},
{
title: t("sidebar.sdk.faq"),
url: "sdk/sdk-faq",
},
],
},
{
section: t("sidebar.sdk.technicalStack"),
contents: [
{
title: t("sidebar.sdk.stackOverview"),
url: formatUrl("sdk/technical-stack/"),
},
{
title: t("sidebar.sdk.configuration"),
url: formatUrl("sdk/technical-stack/configuration"),
},
{
title: t("sidebar.sdk.services"),
url: formatUrl("sdk/technical-stack/services"),
},
{
title: t("sidebar.sdk.smartContracts"),
url: formatUrl("sdk/technical-stack/contracts"),
},
{
title: t("sidebar.sdk.proofGeneration"),
url: formatUrl("sdk/technical-stack/proof-generation"),
},
{
title: t("sidebar.sdk.integrations"),
url: formatUrl("sdk/technical-stack/integrations"),
},
],
},
{
section: t("sidebar.sdk.guides"),
contents: [
{
title: t("sidebar.sdk.devnetDeployment"),
url: formatUrl("sdk/guides/devnet-deployment"),
},
// {
// title: t("sidebar.sdk.productionDeployment"),
// url: formatUrl("sdk/guides/production-deployment"),
// },
{
title: t("sidebar.sdk.digitalOcean"),
url: formatUrl("sdk/guides/digital-ocean-alt-gas-token"),
},
{
title: t("sidebar.sdk.awsDeployment"),
url: formatUrl("sdk/guides/aws-deployment"),
},
{
title: t("sidebar.sdk.customizingSdkComponents"),
url: formatUrl("sdk/guides/customizing-sdk-components"),
},
],
},
{
section: t("sidebar.sdk.operation"),
contents: [
{
title: t("sidebar.sdk.gasAndFees"),
url: formatUrl("sdk/operation/gas-and-fees"),
},
{
title: t("sidebar.sdk.monitoring"),
url: formatUrl("sdk/operation/monitoring"),
},
{
title: t("sidebar.sdk.upgrades"),
url: formatUrl("sdk/operation/upgrades"),
},
{
title: t("sidebar.sdk.troubleshooting"),
url: formatUrl("sdk/operation/troubleshooting"),
},
{
title: t("sidebar.sdk.security"),
url: formatUrl("sdk/operation/security-and-recovery"),
},
],
},
],
}
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 77a4b18

Please sign in to comment.