initial release commit

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,21 @@
+This MR [TODO: Please describe your changes here].
+
+## Checklist:
+
+### 1 - First Draft
+* [ ] Internal technical review completed
+* [ ] Internal language review completed
+* [ ] Topos review requested
+* [ ] Topos review completed
+
+### 2 - Finalized Draft
+* [ ] Internal technical review completed
+* [ ] Internal language review completed
+* [ ] Topos review requested
+* [ ] Topos review completed
+
+### 3 - Release Candidate
+* [ ] Internal technical review completed
+* [ ] Internal language review completed
+* [ ] Topos sign-off requested
+* [ ] Topos sign-off

.github/workflows/deploy-main.yml

@@ -0,0 +1,31 @@
+name: Build & Deploy production
+
+on:
+  push:
+    branches:
+    - main
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 📦 Checkout repository
+        uses: actions/checkout@v4
+      - name: ⚙️ Configure build env
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - name: 🛠️ Build platform
+        run: |
+          npm ci
+          npm run build
+      - name: ⚙️ Configure AWS credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+          aws-region: eu-west-1
+      - name: 🚀 Deploy AWS S3
+        run: |
+          aws s3 sync --delete public ${{ vars.AWS_S3_BUCKET_URL }}
+          aws cloudfront create-invalidation --distribution-id ${{ vars.CF_DISTRIBUTION_ID }} --paths "/*"

.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+node_modules/
+.cache/
+public
+src/gatsby-types.d.ts
+.env
+.nvmrc

.prettierignore

@@ -0,0 +1,6 @@
+# Ignore artifacts:
+public
+.cache
+
+# Ignore all MD files:
+**/*.md

.prettierrc.json

@@ -0,0 +1,3 @@
+{
+  "singleQuote": true
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 ZK Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,49 @@
+# Topos docs platform
+
+This repository contains the documentation platform for the Topos protocol and ZkEcosystem.
+
+The platform is deployed automatically to
+
+➡️ [https://docs.topos.technology](https://docs.topos.technology)
+
+This repository is currently maintained by [B9Lab](https://github.com/b9lab).
+
+## Contribute
+
+We welcome all contributions to this repository. If you see any error or would like to propose an idea, please feel free to open an Issue, or submit an update via a Pull Request.
+
+## Install
+Install packages using
+
+```
+npm install
+```
+(or equivalent commands for your package manager)
+
+For local development, it is recommended to also install the gatsby-cli globally using:
+```
+npm install -g gatsby-cli 
+```
+
+## Configuration
+
+Next to the default `gatsby-config.ts` file, additional configuration options are exposed in `config.ts`.
+
+
+## Run local dev environment
+
+To run a local dev environment, start:
+```
+npm run develop
+```
+
+
+## Build
+
+To build the distribution package, run:
+
+```
+gatsby build
+```
+
+This will generate the dist output in the `public` folder

config.ts

@@ -0,0 +1,112 @@
+import Config from './src/interfaces/Config';
+
+const config: Config = {
+  siteTitle: 'Topos Developer Portal',
+  twitterName: '@topo_protocol',
+  title: 'Developer Portal',
+  rootUrl: 'https://docs.topos.technology/', // used only for the social card atm, required (update when using other environment)
+  protectedRoutePrefix: '/protected', // slash at the beginning, but not at the end. Also the page file name has to match.
+  includeFolder: ['features-test', 'content', 'legal'],
+  indexPath: 'content', // could be content/module-1/introduction.html for example or any path to a html page
+  includeProtectedFolder: [],
+  protectedPagesPath: '',
+  protectedLayoutsPath: '',
+  pageTransitionDuration: 0.2,
+  enableH3Toc: true,
+  headerOffset: 100,
+  docSearch: {
+    appId: 'S36OISFKTX',
+    apiKey: 'fc77ad501873a0a81b4c39e02a4aaaac',
+    indexName: 'crawler_Topos docs platform (new)',
+    placeholder: 'Search documentation'
+  },
+  navigation: [
+    {
+      label: 'What is Topos?',
+      content: [
+        {
+          label: 'Chapter overview: What is Topos?',
+          path: '/content/module-1'
+        },
+        {
+          label: 'Introduction',
+          path: '/content/module-1/1-introduction.html'
+        },
+        {
+          label: 'Why Topos?',
+          path: '/content/module-1/2-why-topos.html'
+        },
+        {
+          label: 'Use cases',
+          path: '/content/module-1/3-use-cases.html'
+        },
+        {
+          label: 'Topos protocol',
+          path: '/content/module-1/4-protocol.html'
+        },
+        {
+          label: 'Cross-subnet messages',
+          path: '/content/module-1/5-cross-subnet.html'
+        },
+        {
+          label: 'Messaging protocol',
+          path: '/content/module-1/6-messaging-protocol.html'
+        }
+      ]
+    },
+    {
+      label: 'First steps with Topos',
+      content: [
+        {
+          label: 'Chapter overview: First steps with Topos',
+          path: '/content/module-2'
+        },
+        {
+          label: 'ERC20 Messaging',
+          path: '/content/module-2/1-ERC20-Messaging.html'
+        },
+        {
+          label: 'Topos Explorer',
+          path: '/content/module-2/2-explorer.html'
+        },
+        {
+          label: 'Topos Playground',
+          path: '/content/module-2/3-topos-playground.html'
+        },
+        {
+          label: 'Topos CLI',
+          path: '/content/module-2/4-cli.html'
+        }
+      ]
+    },
+    {
+      label: 'Topos Terms',
+      content: [
+        {
+          label: 'Glossary',
+          path: '/content/glossary.html'
+        }
+      ]
+    },
+    {
+      label: 'Legal',
+      content: [
+        {
+          label: 'Privacy policy',
+          path: '/legal/privacy-policy.html'
+        }
+      ]
+    }
+  ],
+  footerLinks: [
+    {
+      label: 'Privacy Policy',
+      path: '/legal/privacy-policy.html'
+    }
+  ],
+  storage: {
+    cookieConsentKey: 'cookieConsent'
+  }
+};
+
+export default config;