Skip to content

Commit 9f137d3

Browse files
dghelmdghelm
committed
init commit post-cleanup
0 parents  commit 9f137d3

File tree

401 files changed

+44032
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

401 files changed

+44032
-0
lines changed

‎.editorconfig

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
insert_final_newline = true

‎.env.example

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
ALGOLIA_APP_ID=I9A62UQS9Z
2+
ALGOLIA_WRITE_API_KEY=
3+
ALGOLIA_INDEX_NAME=docs-test

‎.eslintignore

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
dist
2+
.cache
3+
.test
4+
node_modules
5+
.github
6+
.changeset
7+
src/features/redirects/redirects.json
8+
scripts/reference/chainsToBe.json
9+
src/scripts/reference/linkNameSymbol.json
10+
src/scripts/reference/chains.json
11+
scripts/reference/chains.json
12+
scripts/**/*.js
13+
data-source
14+
typechain-types
15+
.eleventy
16+
public/snippets
17+
public/search-index.json
18+
public/samples
19+
package.json
20+
package-lock.json
21+
vercel.json

‎.eslintrc.js

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
module.exports = {
2+
env: {
3+
browser: true,
4+
es2021: true,
5+
node: true,
6+
},
7+
extends: ["standard", "eslint:recommended", "plugin:@typescript-eslint/recommended", "prettier"],
8+
parser: "@typescript-eslint/parser",
9+
parserOptions: {
10+
ecmaVersion: "latest",
11+
sourceType: "module",
12+
},
13+
plugins: ["@typescript-eslint", "prettier"],
14+
rules: {
15+
"prettier/prettier": [2],
16+
},
17+
}

‎.github/ISSUE_TEMPLATE/bug_report.yml

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
body:
3+
- attributes:
4+
value: 'Thanks for taking the time to help out make Scroll Documentation better!'
5+
type: markdown
6+
- attributes:
7+
description: 'A clear and concise description of what the bug is.'
8+
label: 'Describe the bug'
9+
placeholder: 'Tell us what you see!'
10+
id: describe-bug
11+
type: textarea
12+
validations:
13+
required: true
14+
- attributes:
15+
description: 'Steps to reproduce the behavior (If applicable, add screenshots to help explain your problem).'
16+
label: 'To Reproduce'
17+
value: |
18+
1. Go to '...'
19+
2. Click on '....'
20+
3. See error
21+
id: to-reproduce
22+
type: textarea
23+
validations:
24+
required: true
25+
- attributes:
26+
description: 'Copy the links of the concerned pages.'
27+
label: URLs
28+
value: |
29+
- https://docs.scroll.io/..
30+
- ...
31+
id: urls
32+
type: textarea
33+
validations:
34+
required: true
35+
- attributes:
36+
description: 'A clear and concise description of what you expected to happen.'
37+
label: 'Expected behavior'
38+
id: expected-behavior
39+
type: textarea
40+
validations:
41+
required: false
42+
- attributes:
43+
description: 'Add any other context about the problem here.'
44+
label: 'Additional context'
45+
id: additional-context
46+
type: textarea
47+
validations:
48+
required: false
49+
description: 'File a bug report'
50+
labels:
51+
- bug
52+
- triage
53+
name: 'Bug Report'
54+
title: '[Bug]: <your-title-here>'

‎.github/ISSUE_TEMPLATE/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/enhance.yml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
body:
3+
- attributes:
4+
value: 'Thanks for taking the time to help out make Scroll Documentation better!'
5+
type: markdown
6+
- attributes:
7+
description: 'A clear and concise description of what would you like us to improve.'
8+
label: 'What would you like us to improve?'
9+
id: to-improve
10+
type: textarea
11+
validations:
12+
required: true
13+
- attributes:
14+
description: 'A clear and concise description of how important for the users it is?'
15+
label: 'How important it is?'
16+
id: importance
17+
type: textarea
18+
validations:
19+
required: true
20+
description: 'Enhancement of existing docs'
21+
labels:
22+
- enhancement
23+
- triage
24+
name: 'Enhancement'
25+
title: '[Enhancement]: <your-title-here>'

‎.github/ISSUE_TEMPLATE/new_content.yml

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
body:
3+
- attributes:
4+
value: 'Thanks for taking the time to help out make Scroll Documentation better!'
5+
type: markdown
6+
- attributes:
7+
description: 'A clear and concise description of what is missing.'
8+
label: 'What would you like us to add?'
9+
id: what-is-missing
10+
type: textarea
11+
validations:
12+
required: true
13+
- attributes:
14+
description: 'A clear and concise description of how important for the users it is?'
15+
label: 'How important it is?'
16+
id: importance
17+
type: textarea
18+
validations:
19+
required: true
20+
description: 'File a new content request'
21+
labels:
22+
- new content
23+
- triage
24+
name: 'New Content'
25+
title: '[New Content]: <your-title-here>'

‎.github/PULL_REQUEST_TEMPLATE.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
**IMPORTANT: Please do not create a Pull Request without creating an issue first.Any change needs to be discussed before proceeding.**
2+
3+
## Closing issues
4+
5+
<!-- Put `closes #XXXX` in your comment to auto-close the issue that your PR fixes (if such). -->
6+
7+
closes #ISSUE_NUMBER_GOES_HERE
8+
9+
...
10+
11+
## Description
12+
13+
<!-- Please provide enough information so that others can review your pull request: -->
14+
15+
...
16+
17+
## Changes
18+
19+
<!--Explain the **details** for making this change. What existing problem does the pull request solve? -->
20+
21+
- High level
22+
- changes that
23+
- you made
24+
- ...

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

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Update algolia index
2+
3+
on: [push]
4+
5+
jobs:
6+
update-prod-index:
7+
if: ${{ github.ref == 'refs/heads/main' }}
8+
name: Update algolia index
9+
runs-on: ubuntu-latest
10+
env:
11+
ALGOLIA_APP_ID: ${{ secrets.ALGOLIA_APP_ID }}
12+
ALGOLIA_WRITE_API_KEY: ${{ secrets.ALGOLIA_WRITE_API_KEY }}
13+
ALGOLIA_INDEX_NAME: docs-ui
14+
defaults:
15+
run:
16+
working-directory: ./
17+
steps:
18+
- name: Checkout Repo
19+
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
20+
- name: Install Dependencies
21+
run: npm i
22+
- name: Build
23+
run: npm run build
24+
- name: Update index
25+
run: npm run update-algolia-index

‎.gitignore

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# build output
2+
dist/
3+
4+
# dependencies
5+
node_modules/
6+
7+
temp/
8+
9+
# logs
10+
npm-debug.log*
11+
yarn-debug.log*
12+
yarn-error.log*
13+
pnpm-debug.log*
14+
15+
# environment variables
16+
.env
17+
.env.production
18+
19+
# macOS-specific files
20+
.DS_Store
21+
22+
# Docs scripts files
23+
data-source/
24+
addresses.json
25+
scripts/*.js
26+
src/config/*.js
27+
28+
public/search-index.json
29+
30+
*TOBE.json
31+
.test/
32+
typechain-types/
33+
34+
.tmp
35+
36+
.cache
37+
.vscode

‎.husky/clear

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/usr/bin/env sh
2+
. "$(dirname -- "$0")/_/husky.sh"
3+
4+
npx --no -- commitlint --edit ""

‎.husky/pre-commit

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/bin/sh
2+
. "$(dirname "$0")/_/husky.sh"
3+
4+
npx lint-staged

‎.nvmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v16.16.0

‎.prettierignore

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
dist
2+
.cache
3+
.test
4+
node_modules
5+
.github
6+
.changeset
7+
scripts/reference/chainsToBe.json
8+
scripts/**/*.js
9+
data-source
10+
typechain-types
11+
.eleventy
12+
public/snippets
13+
public/search-index.json

‎.prettierrc

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
{
2+
"semi": false,
3+
"singleQuote": false,
4+
"tabWidth": 2,
5+
"trailingComma": "es5",
6+
"printWidth": 120,
7+
"overrides": [
8+
{
9+
"files": "*.sol",
10+
"options": {
11+
"printWidth": 80,
12+
"tabWidth": 4,
13+
"useTabs": false,
14+
"singleQuote": false,
15+
"bracketSpacing": false
16+
}
17+
}
18+
]
19+
}

‎.solhint.json

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"extends": "solhint:recommended",
3+
"plugins": ["prettier"],
4+
"rules": {
5+
"prettier/prettier": "error",
6+
"compiler-version": ["error", ">=0.4.0"],
7+
"func-visibility": ["warn", { "ignoreConstructors": true }]
8+
}
9+
}

‎.solhintignore

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
node_modules
2+
data-source
3+
scripts
4+
src

‎.temp.1674770289347.config.ts

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
import { defineConfig } from "astro/config"
2+
import preact from "@astrojs/preact"
3+
import react from "@astrojs/react"
4+
import { astroCallouts } from "./integrations/astro-callouts"
5+
import { solidityRemixCode } from "./integrations/solidity-remix"
6+
import { youtubeEmbed } from "./integrations/youtube-embed"
7+
import mdx from "@astrojs/mdx"
8+
import rehypeSlug from "rehype-slug"
9+
import rehypeAutolinkHeadings from "rehype-autolink-headings"
10+
import sitemap from "@astrojs/sitemap"
11+
12+
import tailwind from "@astrojs/tailwind"
13+
14+
// https://astro.build/config
15+
export default defineConfig({
16+
site: "https://docs.scroll.io",
17+
legacy: {
18+
astroFlavoredMarkdown: true,
19+
},
20+
integrations: [
21+
preact({
22+
compat: true,
23+
}),
24+
sitemap({
25+
changefreq: "daily",
26+
}),
27+
astroCallouts(),
28+
solidityRemixCode(),
29+
youtubeEmbed(),
30+
mdx(),
31+
tailwind({
32+
// Example: Disable injecting a basic `base.css` import on every page.
33+
// Useful if you need to define and/or import your own custom `base.css`.
34+
config: { applyBaseStyles: false },
35+
}),
36+
],
37+
markdown: {
38+
drafts: true,
39+
rehypePlugins: [
40+
rehypeSlug,
41+
[
42+
rehypeAutolinkHeadings,
43+
{
44+
behavior: "prepend",
45+
},
46+
],
47+
],
48+
syntaxHighlight: "prism",
49+
extendDefaultPlugins: true,
50+
},
51+
})

‎.tool-versions

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
nodejs 16.16.0

‎CODEOWNERS

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* @dwightjl @ritika-b @aelmanaa

0 commit comments

Comments
 (0)