Skip to content
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

feat: Adds SDK documentation #384

Merged
merged 74 commits into from
Oct 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
74 commits
Select commit Hold shift + click to select a range
42b72b1
add initial edits for Scroll SDK pages
dghelm Jul 22, 2024
d192a66
adds content for remaining pages. missing helm info
dghelm Jul 23, 2024
f3dc577
fix guide table
dghelm Jul 23, 2024
ec4814e
revision pass on services page
dghelm Jul 23, 2024
37e2c0b
add communication diagram
dghelm Jul 25, 2024
cea0dd3
add contract deployment details and alphabetize services
dghelm Jul 26, 2024
69bb5b7
added chain-monitor and remove event-watcher
dghelm Jul 29, 2024
bf4ef62
manual contract deployment tip
dghelm Jul 30, 2024
6702a03
update arm64 guide and prover RAM requirements
dghelm Jul 31, 2024
29b7d9e
updates for newest changes in SDK
dghelm Aug 1, 2024
fe94ea8
remove event watcher from communication diagram
dghelm Aug 5, 2024
5295d37
first adjustment for prod readiness
dghelm Aug 26, 2024
92ce7d8
adjust guide for macos
dghelm Aug 26, 2024
ee6c7a7
add devnet guide to sidebar
dghelm Aug 26, 2024
e1acf01
add start of prod doc
dghelm Aug 26, 2024
e88edc5
add prod doc to sidebar
dghelm Aug 26, 2024
6d1e1ce
first pass on digital ocean guide
dghelm Sep 5, 2024
4868e2f
add scalar command for altgas
dghelm Sep 5, 2024
b796c7f
fix scroll-sdk chart links
dghelm Sep 6, 2024
55588e3
update to 'make delete' and include pvc deletion
dghelm Sep 6, 2024
bb947ab
clean up DO guide
dghelm Sep 7, 2024
23ceb93
add node affinity section
dghelm Sep 9, 2024
2af66b3
add replica section
dghelm Sep 9, 2024
44e388c
fix places where scroll-stack has been replaced by scroll-sdk
dghelm Sep 9, 2024
b5542fa
add ingress-dns troubleshooting
dghelm Sep 13, 2024
3d0db0a
first pass on operations, along with prometheus metrics
dghelm Sep 26, 2024
0e1940b
fix import path
dghelm Sep 26, 2024
ac9ddf8
small fixes
dghelm Oct 1, 2024
48573f9
update to latest deployment method
dghelm Oct 8, 2024
e9bceed
first pass preparing for public launch
dghelm Oct 16, 2024
d959dac
doc: add aws deployment
paul-unifra Oct 16, 2024
4b9e4e8
doc: add configuring persistent storage section
paul-unifra Oct 16, 2024
10ed5ff
doc: add cloudflare dns screenshot
paul-unifra Oct 16, 2024
0562457
Merge pull request #372 from paul-unifra/paul/aws-deploy
dghelm Oct 17, 2024
f85bf41
doc: add external-secrets service account creation guide
paul-unifra Oct 17, 2024
9580664
doc: add gp3 sc creation guide and reverting RDS to private access guide
paul-unifra Oct 17, 2024
5c4692a
fix rds security group ingress instructions; allow cluster rather tha…
paul-unifra Oct 17, 2024
4b7437e
Merge pull request #373 from paul-unifra/paul/aws-deploy
dghelm Oct 17, 2024
d79deef
small aws guide fixes
dghelm Oct 17, 2024
c6994fd
merge scroll-sdk-init
dghelm Oct 17, 2024
04c86a4
scaffold additional pages
dghelm Oct 18, 2024
6d26c6f
merge develop
dghelm Oct 20, 2024
77ac002
add troubleshooting page
dghelm Oct 20, 2024
8995111
add section monitor
shu-unifra Oct 22, 2024
7712a90
remove step of install kube-prometheus-stack
shu-unifra Oct 22, 2024
a4ce7a0
remove arm64mac translation
dghelm Oct 22, 2024
49e063c
trigger build
dghelm Oct 22, 2024
2028259
trigger build test 2
dghelm Oct 22, 2024
10b5119
1. add motoring section to digital ocean guide
shu-unifra Oct 23, 2024
598b638
add external proof provider info
dghelm Oct 23, 2024
981e03c
Merge branch 'scroll-sdk-init' into scroll-sdk
dghelm Oct 23, 2024
c39b815
fix command 'helm upgrade' should with option '--reuse-values'
shu-unifra Oct 25, 2024
10a40d8
add frontpage item for sdk, missing icon
dghelm Oct 25, 2024
12f5cd6
add sdk svg
dghelm Oct 25, 2024
c59a439
Merge pull request #376 from shu-unifra/scroll-sdk-init-monitor
dghelm Oct 26, 2024
8698048
update SDK translations in Navigate panel
dghelm Oct 28, 2024
5012a40
add scroll-metrics update
dghelm Oct 28, 2024
bf2c9c1
review technical-stack docs, pt 1
dghelm Oct 28, 2024
5991608
review technical-stack docs, pt 1
dghelm Oct 29, 2024
8205d6a
review technical-stack docs, pt 2
dghelm Oct 29, 2024
4fd487b
review operating-a-chain: gas mgmt
dghelm Oct 29, 2024
35b4b67
review operating-a-chain: gas mgmt, audit additions
dghelm Oct 29, 2024
c4a3cc4
review operating-a-chain: monitoring
dghelm Oct 30, 2024
3491c41
review operating-a-chain: monitoring and upgrading
dghelm Oct 30, 2024
ad5bc70
add guide: customizing sdk component
dghelm Oct 30, 2024
71cb0df
review operating-a-chain: security
dghelm Oct 30, 2024
2980090
add ubuntu to devnet guide
dghelm Oct 30, 2024
cd366ed
fixes to devnet guide
dghelm Oct 30, 2024
10ed793
Merge pull request #13 from scroll-tech/scroll-sdk
Turupawn Oct 30, 2024
79e74ae
fix: linux user docker setup
Turupawn Oct 30, 2024
23c746e
Merge pull request #383 from Turupawn/sdk
dghelm Oct 31, 2024
cc4ba7d
add todos for cli updates and grafana dashboard img
dghelm Oct 31, 2024
d0b77e1
remove incomplete and dated Production Deployment page
dghelm Oct 31, 2024
16e4100
launch notes
dghelm Oct 31, 2024
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
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