Nextra POC (#290)

* Update SUMMARY.md (#251)

* Update SUMMARY.md

* Update SUMMARY.md

* Add GH action for readability (#254)

Co-authored-by: Tanay Pant <tanaypantprotonmail.com>

* Add workflow for style check on PRs (#255)

Co-authored-by: Tanay Pant <tanaypantprotonmail.com>

* Update workflow setting

* Add link check workflow (#257)

* Add link check workflow

* Fix errors

---------

Co-authored-by: Tanay Pant <tanaypantprotonmail.com>

* Remove link check GH action

* Link check workflow (#259)

* Link check workflow

* Test a fix

* Updates

* Fixes

---------

Co-authored-by: Tanay Pant <tanaypantprotonmail.com>

* Add weekly link checker (#260)

* Add weekly link checker

* Minor updates

---------

Co-authored-by: Tanay Pant <tanaypantprotonmail.com>

* Add manual trigger for testing

* Fix conditional for issue creation

* Update conditional for workflow

* Minor updates to the workflow

* Update information architecture (#265)

* Update information architecture

* Update minimum alert level for Vale

* Remove unused files

---------

Co-authored-by: Tanay Pant <tanaypantprotonmail.com>

* Update Safe Apps section (#267)

* Update Safe Docs

* Update README.md

* Add new vocabulary

* Update README.md

* Update get-started.md

* Update get-started.md

* Add new vocab

* Update release.md

* Update release.md

* Add new vocab

* New words

* Update release.md

* Update release.md

* Update safe-apps/release.md

Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>

* Update safe-apps/release.md

Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>

* Update safe-apps/release.md

Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>

---------

Co-authored-by: Tanay Pant <tanaypantprotonmail.com>
Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>

* Update IA for reference (#268)

* Update IA

* Fixes

* Move files around

* Update SUMMARY.md

---------

Co-authored-by: Tanay Pant <tanaypantprotonmail.com>

* docs: fix typos (#271)

* docs: fix typos

* Update safe-apps/release.md

revert typo walkthroughts

Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>

* Update safe-core-api/rpc-requirements.md

fix typos

Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>

* Update safe-core-api/rpc-requirements.md

Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>

* Update safe-core-api/rpc-requirements.md

Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>

* Update safe-core-api/rpc-requirements.md

fix typos

Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>

* Update safe-apps/release.md

fix typo

Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>

---------

Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>

* fix: update `@web3auth/*` versions (#270)

* fix: update `@web3auth/*` versions

* fix: revert formatting

* Update README.md (#276)

* Add script to generate Supported Networks pages from safe-deployments repo as a github action (#278)

* Add script to genereate Supported Networks pages from safe-deployments repo as a github action

* Update summary

* Update summary

* Fix typo in supported networks script & re-generate .md files

* Implement requested changes

* Implement requested changes

* Remove unused console.log; fix supported networks index page & block explorers

* Fix some vale errors ("networks's" & "Testnet")

* Re-generate supported networks

* Implement requested changes (wording & correct section)

* Update SUMMARY.md

* Update SUMMARY.md

* Update SUMMARY.md

* Update SUMMARY.md

* Update SUMMARY.md

* Move supported networks .md folder into safe-smart-accounts

* Implement requested changes (create PR on workflow, minor fixes)

* Update vale dictionnary

* Update vale dictionnary

* Remove duplicates in vale dictionnary

* Remove unnecessary steps in github workflow for supported networks

* Remove duplicates in vale dictionnary

* Alphabetize & deduplicate vale dictionnary

* Exclude deprecated block explorer from supported networks page generation

---------

Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>

* Link checks (#275)

* Fix some link checker errors

* Fix some link checker errors

* Fix some link checker errors

* Add Pimlico to Safe Modules (#279)

* Update modules.md

* Update accept.txt

* Update weekly-link-check.yml (#281)

* Revert "Update weekly-link-check.yml (#281)" (#283)

This reverts commit 4d2f19d.

* Link fixes (#284)

* Update README.md

* Update MoneriumPack.md

* Link checks (#285)

* Fix some link checker errors

* Fix some link checker errors

* Fix some link checker errors

* Fix broken links

* Re-generate .md files

* protocol-kit v2.0 (#266)

* update ethers docs

* add singleton change to api-kit and protocol-kit
update api-kit initialization
update createTransaction use

* update GelatoRelayKit breaking changes

* fix wording recommendations

* highlight ethers.js v6

* add migration guides highlighting the major changes

---------

Co-authored-by: Daniel <25051234+dasanra@users.noreply.github.com>

* Switch from gitbook to nextra

* Migrate getting started section

* Migrate assets

* Migrate misc section

* Migrate safe-apps section

* Migrate safe-core-api section

* Migrate safe-core-sdk section

* Migrate safe-smart-account section

* Migrate safe-core-protocol section

* Add index page

* Update generate supported network script

* Fix broken links & vale errors

* Fix vale errors

* Fix vale errors

* Fix vale errors

* Reorder sidebar (#292)

* Update SUMMARY.md

* Update and rename available-services.md to supported-networks.md

* Implement design feedback (color palette, font)

* Add torusscan as a deprecated block explorer in generateSupportedNetworks

* Add footer from safe.global

* Remove Home component; redirect index to first page

* Implement design feedback (navbar background color & backdrop filter)

* Add legacy `safe-core-sdk` migration guide (#291)

* update ethers docs

* add singleton change to api-kit and protocol-kit
update api-kit initialization
update createTransaction use

* Fix linting and typos

* fix: broken links

* update GelatoRelayKit breaking changes

* improve parameter naming

* fix linter reported issue

* fix wording recommendations

* highlight ethers.js v6

* add migration guides highlighting the major changes

* fix typos

* Apply suggestions from code review

Co-authored-by: Tanay Pant <7481165+tanay1337@users.noreply.github.com>

* add backticks to EthersAdapter

* Apply suggestions from code review

Co-authored-by: Tanay Pant <7481165+tanay1337@users.noreply.github.com>

* set migrating guides below reference

* add wording suggestions

* Add safe-transaction-service migration guide

* Add migration guide from legacy safe-core-sdk

* Add types changes

* remove auth-kit changes

* fix linting issues

* improve api-kit v2 migration

* Add latest changes

* Add missing type

* fix typo

* Apply suggestions from code review

Co-authored-by: Tanay Pant <7481165+tanay1337@users.noreply.github.com>

* add migration links

* Update safe-core-sdk/protocol-kit/reference/migrating/v1.md

Co-authored-by: Tanay Pant <7481165+tanay1337@users.noreply.github.com>

* Reverse migration links order in SUMMARY

---------

Co-authored-by: Daniel Somoza <daniel.somoza@safe.global>
Co-authored-by: Tanay Pant <7481165+tanay1337@users.noreply.github.com>

* Add middleware information for Safe Apps (#293)

* Update get-started.md

* Update accept.txt

* Fix information architecture

* Fix error in code snippet (#295)

* Fix all images &  callouts

* Collapse sidebar menu items

* Add deployment workflow

* Fix deployment workflow

* Fix deployment workflow

* Fix deployment workflow

* docs(auth-kit): Update docs for the new `SafeAuthPack` (#289)

* add protocol-kit v2 updates

* Add SafeAuth information

* Update ethersv6 changes

* Fix deployment workflow

* Fix deployment workflow

* Fix deployment workflow

* fix broken links (#296)

* fix broken links

* fix: link name

* Minor fixes

* chore: Improve auth-kit docs (#298)

* Fix broken links

* Force dark theme

* Fix generate supported networks

* Add avax.boba.network as deprecated block explorers

* Fix generate supported networks (#299)

* Fix generate supported networks

* Generate supported networks .md files

* Edit vocab

* Add toruscan as deprecated block explorer

* Add favicon; fix theme color.

* Cherry pick merged changes from #289

* Cherry pick merged changes from #291

* Cherry pick merged changes from subsequent PRs

* Fix link checker & vale errors

* Add eslint, standard, husky

* Fix lint errors

* Fix pre-push commit hook

* Fix theme import

* Set Google Form for first Safe App review contact (#303)

* Feedback widget design. WIP logic

* Add google analytics

* Move contact-us links in footer

* Rename all files with prefixes

* Add local link checker to prepush hook

* Minor fix

* Fix vale config

* Add missing content from `main`

* Add redirections from gitbook paths

* Fix eslint config

* Remove linkchecker from prepush hook

* Add legacy redirects

* Custom 404 page

* Fix breaking changes in vale v3

* fix: link view inside hint element not showing as expected (#307)

* Restore signature files (#308)

* Restore signatures

* Fix link

* Fix conflicts with signatures

* Update gitignore

* Fix Vale errors

* Accept words with Vale

* Fix vale errors; add vale to lint command.

* Fix build

* Fix redirect link

* Implement requested changes

* Add redirections test

* Fix tsconfig

* Fix typos in redirects

* Fix typo in redirects

* Switch all routes to kebab-case

---------

Co-authored-by: Tanay Pant <7481165+tanay1337@users.noreply.github.com>
Co-authored-by: Tanay Pant <tanaypantprotonmail.com>
Co-authored-by: Germán Martínez <6764315+germartinez@users.noreply.github.com>
Co-authored-by: xiaolou86 <20718693+xiaolou86@users.noreply.github.com>
Co-authored-by: Aaron Cook <aaron@safe.global>
Co-authored-by: Dani Somoza <dasomoza@gmail.com>
Co-authored-by: Daniel <25051234+dasanra@users.noreply.github.com>
Co-authored-by: Daniel Somoza <daniel.somoza@safe.global>
Co-authored-by: Pran <15847009+heypran@users.noreply.github.com>
Co-authored-by: Yago Pérez Vázquez <yago@safe.global>
Co-authored-by: Germán Martínez <germaga92@gmail.com>

.env.example

@@ -0,0 +1,3 @@
+NEXT_PUBLIC_HOST_URL='http://localhost:3000'
+NEXT_PUBLIC_GOOGLE_ANALYTICS_TRACKING_ID=
+NEXT_PUBLIC_GOOGLE_ANALYTICS_DOMAIN=

.eslintrc.js

@@ -0,0 +1,28 @@
+module.exports = {
+  parser: '@typescript-eslint/parser',
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:security/recommended-legacy',
+    'standard-with-typescript',
+    'next/core-web-vitals'
+  ],
+  parserOptions: {
+    project: './tsconfig.json'
+  },
+  ignorePatterns: ['.eslintrc.js', 'next.config.js', 'next-env.d.ts', 'out'],
+  rules: {
+    '@typescript-eslint/key-spacing': 0,
+    'multiline-ternary': 0,
+    'no-console': ['error', { allow: ['info', 'warn', 'error'] }],
+    'max-len': [
+      2,
+      {
+        code: 100,
+        ignoreComments: true,
+        ignoreStrings: true,
+        ignoreTemplateLiterals: true,
+        ignoreUrls: true
+      }
+    ]
+  }
+}

.github/scripts/generateSupportedNetworks.js

@@ -0,0 +1,156 @@
+// This script generates the supported networks page from the safe-deployments repo.
+// It clones the repo, reads the JSON files, and generates the markdown files as well as a _meta.json file for nextra.
+
+const shell = require('shelljs')
+const fs = require('fs')
+const path = require('path')
+
+// Explore a given directory recursively and return all the file paths
+const walkPath = dir => {
+  let results = []
+  const list = fs.readdirSync(dir)
+  list.forEach(function (file) {
+    const filePath = path.join(dir, file)
+    const stat = fs.statSync(filePath)
+    if (stat?.isDirectory()) {
+      results = results.concat(walkPath(filePath))
+    } else {
+      results.push(filePath)
+    }
+  })
+
+  return results
+}
+
+// Reduce function to deduplicate an array
+const deduplicate = (acc, curr) => {
+  if (acc.includes(curr)) {
+    return acc
+  }
+
+  return [...acc, curr]
+}
+
+const supportedNetworksPath = './pages/safe-smart-account/supported-networks'
+
+const generateSupportedNetworks = async () => {
+  const deploymentRepoUrl = 'https://github.com/safe-global/safe-deployments/'
+  shell.exec(`git clone ${deploymentRepoUrl} ./deployments`)
+  shell.rm('-rf', supportedNetworksPath)
+
+  const fetch = await import('node-fetch')
+  const paths = walkPath('deployments/src/assets').map(p =>
+    p.replace('deployments/src/assets/', '')
+  )
+
+  const allNetworks = await fetch
+    .default('https://chainid.network/chains.json')
+    .then(res => res.json())
+
+  const contracts = paths.map(p => {
+    const file = fs.readFileSync(`deployments/src/assets/${p}`, 'utf8')
+    const json = JSON.parse(file)
+
+    return Object.entries(json.networkAddresses).map(([chainId, address]) => ({
+      name: p.split('/')[1].split('.')[0],
+      version: p.split('/')[0],
+      address,
+      chainId,
+      chainName: allNetworks.find(n => n.chainId === parseInt(chainId))?.name,
+      blockExplorerUrl: allNetworks.find(n => n.chainId === parseInt(chainId))
+        ?.explorers?.[0]?.url
+    }))
+  })
+
+  const versions = contracts
+    .flat()
+    .map(c => c.version)
+    .reduce(deduplicate, [])
+    .reverse()
+
+  shell.mkdir(supportedNetworksPath)
+
+  versions.forEach(version => {
+    const _contracts = contracts.flat().filter(c => c.version === version)
+
+    const networks = Object.entries(
+      _contracts.reduce((acc, curr) => {
+        const { chainId, chainName } = curr
+        if (acc[chainId]) {
+          return acc
+        }
+
+        return {
+          ...acc,
+          [chainId]: chainName
+        }
+      }, {})
+    )
+
+    const content = `# ${version}
+
+This page lists the addresses of all the Safe contracts \`${version}\` grouped by chain.
+
+## Networks
+${networks
+  .map(([chainId, network]) => {
+    return `
+### ${network}
+
+This network's chain ID is ${chainId}.
+
+${_contracts
+  .filter(c => c.chainId === chainId)
+  .map(
+    c =>
+      `- \`${c.name}.sol\`: ${
+        c.blockExplorerUrl == null ||
+        deprecatedBlockExplorers.includes(c.blockExplorerUrl)
+          ? c.address
+          : `[${c.address}](${c.blockExplorerUrl}/address/${c.address})`
+      }`
+  )
+  .join('\n')}
+`
+  })
+  .join('\n')}
+
+    `
+    fs.writeFileSync(`${supportedNetworksPath}/${version}.md`, content)
+  })
+
+  // Generate _meta.json file to order versions in descending order
+  fs.writeFileSync(
+    `${supportedNetworksPath}/_meta.json`,
+    JSON.stringify(
+      versions.reduce((acc, curr) => ({ ...acc, [curr]: curr }), {}),
+      null,
+      2
+    )
+  )
+
+  shell.rm('-rf', './deployments')
+}
+
+generateSupportedNetworks()
+
+const deprecatedBlockExplorers = [
+  'https://ropsten.etherscan.io',
+  'https://rinkeby.etherscan.io',
+  'https://kovan-optimistic.etherscan.io',
+  'https://stardust-explorer.metis.io',
+  'https://blockexplorer.rinkeby.boba.network',
+  'https://blockexplorer.bobabeam.boba.network',
+  'https://blockexplorer.avax.boba.network',
+  'https://rabbit.analogscan.com',
+  'https://explorer.eurus.network',
+  'https://testnetexplorer.eurus.network',
+  'https://explorer.tst.publicmint.io',
+  'https://evm-testnet.venidiumexplorer.com',
+  'https://evm.venidiumexplorer.com',
+  'https://evm.explorer.canto.io',
+  'https://explorer.autobahn.network',
+  'https://explorer.cascadia.foundation',
+  'https://testnet.torusscan.com',
+  'https://testnet.toruscan.com'
+]

.github/scripts/s3_upload.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+set -ev
+
+aws s3 sync ./out $BUCKET --delete
+
+# Upload all HTML files again but w/o an extention so that URLs like /welcome open the right page
+
+cd out
+
+for file in $(find . -name '*.html' | sed 's|^\./||'); do
+    aws s3 cp ${file%} $BUCKET/${file%.*} --content-type 'text/html'
+done

styles/Microsoft/DateOrder.yml → .github/styles/Microsoft/DateOrder.yml

@@ -2,7 +2,7 @@ extends: existence
 message: "Always spell out the name of the month."
 link: https://docs.microsoft.com/en-us/style-guide/numbers#numbers-in-dates
 ignorecase: true
-level: error
+level: warning
 nonword: true
 tokens:
   - '\b\d{1,2}/\d{1,2}/(?:\d{4}|\d{2})\b'