From c80d0ed8e834b7d5f0d4b9f1c34c65aec59377ec Mon Sep 17 00:00:00 2001 From: Alex Telegin Date: Wed, 27 Dec 2023 18:00:56 +0700 Subject: [PATCH] Add basic project overview --- .vitepress/config.mts | 4 +- README.md | 18 +++++++++ RaaS.md | 11 ++++++ api-examples.md | 49 ------------------------ dAppStore.md | 15 ++++++++ overview.md | 86 ++++--------------------------------------- 6 files changed, 53 insertions(+), 130 deletions(-) create mode 100644 README.md create mode 100644 RaaS.md delete mode 100644 api-examples.md create mode 100644 dAppStore.md diff --git a/.vitepress/config.mts b/.vitepress/config.mts index 37031c5..9874751 100644 --- a/.vitepress/config.mts +++ b/.vitepress/config.mts @@ -22,7 +22,6 @@ export default defineConfig({ // https://vitepress.dev/reference/default-theme-config nav: [ { text: 'Home', link: '/' }, - { text: 'Examples', link: '/markdown-examples' } ], sidebar: [ @@ -30,7 +29,8 @@ export default defineConfig({ text: 'Documentation', items: [ { text: 'Overview', link: '/overview' }, - { text: 'Runtime API Examples', link: '/api-examples' } + { text: 'Rollup as a Service', link: '/RaaS' }, + { text: 'dApp Store', link: '/dAppStore' } ] } ], diff --git a/README.md b/README.md new file mode 100644 index 0000000..81e90d9 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Scalind Documentation + +This is documentation for [Scalind](https://scalind.com/) Rollup as a Service platform. + +## Development + +Setup dependencies: +``` +bun install +``` +Run development server: +``` +bun docs:dev +``` +On push to master branch the documentation is automatically deployed to [Scalind Docs page](https://docs.scalind.com/) + +### Contributing +PRs with corrections are always welcome diff --git a/RaaS.md b/RaaS.md new file mode 100644 index 0000000..cd98977 --- /dev/null +++ b/RaaS.md @@ -0,0 +1,11 @@ +--- +outline: deep +--- + +# RaaS basics + +Rollups have proven to be the greatest way to solve the scaling issue with modern L1 blockchains. We help setup rollups on different technological stacks without diving deep into the implementation and help drastically remove speed-to-market + +The default technological stack that we are starting with is based on Optimism's implementation - the [OP Stack](https://docs.optimism.io/stack/getting-started) for modular rollups. It's proven and tested on numerous chains besides the OP Mainnet and is a well-studied codebase that's maintained by dozens of talented engineers. Scalind is proud to be the [Builder's grant recipient](https://gov.optimism.io/t/cycle-15-final-grants-roundup/6858) and we try to contribute to the Optimism ecosystem to move the progress forward + +Besides Optimism, Scalind team is doing working on integrating Arbitrum rollups and allowing the customisation of the modular rollup stack with different DA and Settlement layers. The progress is going to be covered in this documentation in real time diff --git a/api-examples.md b/api-examples.md deleted file mode 100644 index 6bd8bb5..0000000 --- a/api-examples.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -outline: deep ---- - -# Runtime API Examples - -This page demonstrates usage of some of the runtime APIs provided by VitePress. - -The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files: - -```md - - -## Results - -### Theme Data -
{{ theme }}
- -### Page Data -
{{ page }}
- -### Page Frontmatter -
{{ frontmatter }}
-``` - - - -## Results - -### Theme Data -
{{ theme }}
- -### Page Data -
{{ page }}
- -### Page Frontmatter -
{{ frontmatter }}
- -## More - -Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata). diff --git a/dAppStore.md b/dAppStore.md new file mode 100644 index 0000000..28d85ea --- /dev/null +++ b/dAppStore.md @@ -0,0 +1,15 @@ +# dApp Store + +We allow you to laucnh different open-source dApps that can help bring life into the chain and help drive user activity + +## Multi-signature wallet + +Multisigs are a neccesity for anyone who stores a lot of value on chain. We help you setup a safe deployment based on Gnosis Safe implementation - this is the industry standard and a tool familiar to crypto users so there won't be any learning curve for the audience + +## Decentralized exchange + +A DEX is necessary to allow for tokens trading on-chain. We help you setup a Uniswap V2 based exchange which has proven to be the backbone of DeFi on all the major and up-and-coming chains + +## Deployment guide + +Currently we help with the manual setup of these dApps while the automated deployment and an actual store is underway. Once finished, you would be able to make a deployment in a matter of minutes on any EVM-compatible chain right from the web UI of Scalind dApp Store \ No newline at end of file diff --git a/overview.md b/overview.md index 3ea9aa9..d0786f9 100644 --- a/overview.md +++ b/overview.md @@ -1,85 +1,13 @@ -# Markdown Extension Examples +# Vision -This page demonstrates some of the built-in markdown extensions provided by VitePress. +Scalind is a blockchain infrastructure company, we aim to provide clients with both ways to create new and cheaper chains, as well as access to RPC infrastructure to communicate with existing chains -## Syntax Highlighting +What we do: -VitePress provides Syntax Highlighting powered by [Shikiji](https://github.com/antfu/shikiji), with additional features like line-highlighting: +## [Rollup as a service](/RaaS) -**Input** +Launch a custom L2 blockchain on top of an L1 of your choice. Assisted chain setup can be done within one day, and total time to market is around 2 weeks to get the chain on the public registries etc. -````md -```js{4} -export default { - data () { - return { - msg: 'Highlighted!' - } - } -} -``` -```` +## [dApp Store](/dAppStore) -**Output** - -```js{4} -export default { - data () { - return { - msg: 'Highlighted!' - } - } -} -``` - -## Custom Containers - -**Input** - -```md -::: info -This is an info box. -::: - -::: tip -This is a tip. -::: - -::: warning -This is a warning. -::: - -::: danger -This is a dangerous warning. -::: - -::: details -This is a details block. -::: -``` - -**Output** - -::: info -This is an info box. -::: - -::: tip -This is a tip. -::: - -::: warning -This is a warning. -::: - -::: danger -This is a dangerous warning. -::: - -::: details -This is a details block. -::: - -## More - -Check out the documentation for the [full list of markdown extensions](https://vitepress.dev/guide/markdown). +Populate any chain (including the ones not managed by Scalind) with the base applications you might need, from multi-signature wallets to exchanges and more \ No newline at end of file