merge main

Signed-off-by: Sally MacFarlane <[email protected]>

.cspell.json

@@ -0,0 +1,41 @@
+{
+  "version": "0.2",
+  "gitignoreRoot": ".",
+  "useGitignore": true,
+  "dictionaries": [
+    "css",
+    "html",
+    "fonts",
+    "typescript",
+    "softwareTerms",
+    "companies",
+    "lorem-ipsum",
+    "project-words"
+  ],
+  "dictionaryDefinitions": [
+    {
+      "name": "project-words",
+      "path": "./project-words.txt",
+      "noSuggest": true
+    }
+  ],
+  "ignorePaths": [
+    "CHANGELOG.md",
+    "LICENSE",
+    "package.json",
+    "yarn.lock",
+    "project-words.txt",
+    "__snapshots__",
+    "*.min.*",
+    "jest/vendor",
+    "docusaurus.config.js",
+    "src/css/",
+    "babel.config.js",
+    "api/",
+    "docs/test-api/",
+    "sidebars.js",
+    "tsconfig.*.json",
+    ".github/**"
+  ],
+  "ignoreRegExpList": ["Email", "Urls", "#[\\w-]*"]
+}

.editorconfig

@@ -1,16 +1,16 @@
-[*]
-charset=utf-8
-end_of_line=lf
-trim_trailing_whitespace=true
-insert_final_newline=true
-indent_style=space
-indent_size=2
+# http://editorconfig.org
 
-[.editorconfig]
-indent_style=space
-indent_size=4
+root = true
 
-[{*.yml,*.yaml}]
-indent_style=space
-indent_size=2
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+max_line_length = 80
+trim_trailing_whitespace = true
 
+[*.md]
+insert_final_newline = false
+trim_trailing_whitespace = false

.eslintignore

@@ -0,0 +1,7 @@
+build/
+.eslintrc.js
+docs/test-api
+./node_modules/*
+*.md
+*.mdx
+LICENSE

.eslintrc.js

@@ -0,0 +1,17 @@
+module.exports = {
+  extends: [
+    "plugin:@docusaurus/recommended",
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module",
+    "ecmaFeatures": {
+      "jsx": true
+    },
+    project: ["./tsconfig.json"]
+  },
+  rules: {
+    '@docusaurus/no-untranslated-text': 0
+  },
+};

.github/workflows/build.yml

@@ -0,0 +1,26 @@
+---
+name: Build
+
+on:
+  pull_request:
+    branches:
+      - main
+    # Review gh actions docs if you want to further define triggers, paths, etc
+    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    # the enviroment to deploy to / use secrets from
+    environment: no-secret
+    # modify the default permissions of the GITHUB_TOKEN, so as to only allow least priveleges
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Build
+        uses: ConsenSys/docs-gha/build@main
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}