init commit post-cleanup

.editorconfig

@@ -0,0 +1 @@
+insert_final_newline = true

.env.example

@@ -0,0 +1,3 @@
+ALGOLIA_APP_ID=I9A62UQS9Z
+ALGOLIA_WRITE_API_KEY=
+ALGOLIA_INDEX_NAME=docs-test

.eslintignore

@@ -0,0 +1,21 @@
+dist
+.cache
+.test
+node_modules
+.github
+.changeset
+src/features/redirects/redirects.json
+scripts/reference/chainsToBe.json
+src/scripts/reference/linkNameSymbol.json
+src/scripts/reference/chains.json
+scripts/reference/chains.json
+scripts/**/*.js
+data-source
+typechain-types
+.eleventy
+public/snippets
+public/search-index.json
+public/samples
+package.json
+package-lock.json
+vercel.json

.eslintrc.js

@@ -0,0 +1,17 @@
+module.exports = {
+  env: {
+    browser: true,
+    es2021: true,
+    node: true,
+  },
+  extends: ["standard", "eslint:recommended", "plugin:@typescript-eslint/recommended", "prettier"],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    ecmaVersion: "latest",
+    sourceType: "module",
+  },
+  plugins: ["@typescript-eslint", "prettier"],
+  rules: {
+    "prettier/prettier": [2],
+  },
+}

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,54 @@
+---
+body:
+  - attributes:
+      value: 'Thanks for taking the time to help out make Scroll Documentation better!'
+    type: markdown
+  - attributes:
+      description: 'A clear and concise description of what the bug is.'
+      label: 'Describe the bug'
+      placeholder: 'Tell us what you see!'
+    id: describe-bug
+    type: textarea
+    validations:
+      required: true
+  - attributes:
+      description: 'Steps to reproduce the behavior (If applicable, add screenshots to help explain your problem).'
+      label: 'To Reproduce'
+      value: |
+        1. Go to '...'
+        2. Click on '....'
+        3. See error
+    id: to-reproduce
+    type: textarea
+    validations:
+      required: true
+  - attributes:
+      description: 'Copy the links of the concerned pages.'
+      label: URLs
+      value: |
+        - https://docs.scroll.io/..
+        - ...
+    id: urls
+    type: textarea
+    validations:
+      required: true
+  - attributes:
+      description: 'A clear and concise description of what you expected to happen.'
+      label: 'Expected behavior'
+    id: expected-behavior
+    type: textarea
+    validations:
+      required: false
+  - attributes:
+      description: 'Add any other context about the problem here.'
+      label: 'Additional context'
+    id: additional-context
+    type: textarea
+    validations:
+      required: false
+description: 'File a bug report'
+labels:
+  - bug
+  - triage
+name: 'Bug Report'
+title: '[Bug]: <your-title-here>'

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/enhance.yml

@@ -0,0 +1,25 @@
+---
+body:
+  - attributes:
+      value: 'Thanks for taking the time to help out make Scroll Documentation better!'
+    type: markdown
+  - attributes:
+      description: 'A clear and concise description of what would you like us to improve.'
+      label: 'What would you like us to improve?'
+    id: to-improve
+    type: textarea
+    validations:
+      required: true
+  - attributes:
+      description: 'A clear and concise description of how important for the users it is?'
+      label: 'How important it is?'
+    id: importance
+    type: textarea
+    validations:
+      required: true
+description: 'Enhancement of existing docs'
+labels:
+  - enhancement
+  - triage
+name: 'Enhancement'
+title: '[Enhancement]: <your-title-here>'

.github/ISSUE_TEMPLATE/new_content.yml

@@ -0,0 +1,25 @@
+---
+body:
+  - attributes:
+      value: 'Thanks for taking the time to help out make Scroll Documentation better!'
+    type: markdown
+  - attributes:
+      description: 'A clear and concise description of what is missing.'
+      label: 'What would you like us to add?'
+    id: what-is-missing
+    type: textarea
+    validations:
+      required: true
+  - attributes:
+      description: 'A clear and concise description of how important for the users it is?'
+      label: 'How important it is?'
+    id: importance
+    type: textarea
+    validations:
+      required: true
+description: 'File a new content request'
+labels:
+  - new content
+  - triage
+name: 'New Content'
+title: '[New Content]: <your-title-here>'

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,24 @@
+**IMPORTANT: Please do not create a Pull Request without creating an issue first.Any change needs to be discussed before proceeding.**
+
+## Closing issues
+
+<!-- Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such). -->
+
+closes #ISSUE_NUMBER_GOES_HERE
+
+...
+
+## Description
+
+<!-- Please provide enough information so that others can review your pull request: -->
+
+...
+
+## Changes
+
+<!--Explain the **details** for making this change. What existing problem does the pull request solve? -->
+
+- High level
+- changes that
+- you made
+- ...

.github/workflows/update-algolia-index.yml

@@ -0,0 +1,25 @@
+name: Update algolia index
+
+on: [push]
+
+jobs:
+  update-prod-index:
+    if: ${{ github.ref == 'refs/heads/main' }}
+    name: Update algolia index
+    runs-on: ubuntu-latest
+    env:
+      ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
+      ALGOLIA_WRITE_API_KEY: ${{ secrets.ALGOLIA_WRITE_API_KEY }}
+      ALGOLIA_INDEX_NAME: docs-ui
+    defaults:
+      run:
+        working-directory: ./
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
+      - name: Install Dependencies
+        run: npm i
+      - name: Build
+        run: npm run build
+      - name: Update index
+        run: npm run update-algolia-index

.gitignore

@@ -0,0 +1,37 @@
+# build output
+dist/
+
+# dependencies
+node_modules/
+
+temp/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store
+
+# Docs scripts files
+data-source/
+addresses.json
+scripts/*.js
+src/config/*.js
+
+public/search-index.json
+
+*TOBE.json
+.test/
+typechain-types/
+
+.tmp
+
+.cache
+.vscode

.husky/clear

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit ""

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

.nvmrc

@@ -0,0 +1 @@
+v16.16.0

.prettierignore

@@ -0,0 +1,13 @@
+dist
+.cache
+.test
+node_modules
+.github
+.changeset
+scripts/reference/chainsToBe.json
+scripts/**/*.js
+data-source
+typechain-types
+.eleventy
+public/snippets
+public/search-index.json

.prettierrc

@@ -0,0 +1,19 @@
+{
+  "semi": false,
+  "singleQuote": false,
+  "tabWidth": 2,
+  "trailingComma": "es5",
+  "printWidth": 120,
+  "overrides": [
+    {
+      "files": "*.sol",
+      "options": {
+        "printWidth": 80,
+        "tabWidth": 4,
+        "useTabs": false,
+        "singleQuote": false,
+        "bracketSpacing": false
+      }
+    }
+  ]
+}

.solhint.json

@@ -0,0 +1,9 @@
+{
+  "extends": "solhint:recommended",
+  "plugins": ["prettier"],
+  "rules": {
+    "prettier/prettier": "error",
+    "compiler-version": ["error", ">=0.4.0"],
+    "func-visibility": ["warn", { "ignoreConstructors": true }]
+  }
+}

.solhintignore

@@ -0,0 +1,4 @@
+node_modules
+data-source
+scripts
+src

.temp.1674770289347.config.ts

@@ -0,0 +1,51 @@
+import { defineConfig } from "astro/config"
+import preact from "@astrojs/preact"
+import react from "@astrojs/react"
+import { astroCallouts } from "./integrations/astro-callouts"
+import { solidityRemixCode } from "./integrations/solidity-remix"
+import { youtubeEmbed } from "./integrations/youtube-embed"
+import mdx from "@astrojs/mdx"
+import rehypeSlug from "rehype-slug"
+import rehypeAutolinkHeadings from "rehype-autolink-headings"
+import sitemap from "@astrojs/sitemap"
+
+import tailwind from "@astrojs/tailwind"
+
+// https://astro.build/config
+export default defineConfig({
+  site: "https://docs.scroll.io",
+  legacy: {
+    astroFlavoredMarkdown: true,
+  },
+  integrations: [
+    preact({
+      compat: true,
+    }),
+    sitemap({
+      changefreq: "daily",
+    }),
+    astroCallouts(),
+    solidityRemixCode(),
+    youtubeEmbed(),
+    mdx(),
+    tailwind({
+      // Example: Disable injecting a basic `base.css` import on every page.
+      // Useful if you need to define and/or import your own custom `base.css`.
+      config: { applyBaseStyles: false },
+    }),
+  ],
+  markdown: {
+    drafts: true,
+    rehypePlugins: [
+      rehypeSlug,
+      [
+        rehypeAutolinkHeadings,
+        {
+          behavior: "prepend",
+        },
+      ],
+    ],
+    syntaxHighlight: "prism",
+    extendDefaultPlugins: true,
+  },
+})

.tool-versions

@@ -0,0 +1 @@
+nodejs 16.16.0

CODEOWNERS

@@ -0,0 +1 @@
+*   @dwightjl @ritika-b @aelmanaa