Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: Consensys/docs-template
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: v1.18.3
Choose a base ref
...
head repository: Consensys/docs-template
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: main
Choose a head ref

Commits on Mar 30, 2023

  1. chore: docusaurus v2.4.0

    and other updates
    Eric Lin committed Mar 30, 2023
    1
    Copy the full SHA
    909c379 View commit details

Commits on May 17, 2023

  1. Copy the full SHA
    1eb066c View commit details

Commits on May 19, 2023

  1. add index page

    alexandratran committed May 19, 2023
    Copy the full SHA
    38fed31 View commit details

Commits on May 23, 2023

  1. edits

    alexandratran committed May 23, 2023
    Copy the full SHA
    7c8b947 View commit details

Commits on Jun 1, 2023

  1. fix(updated readme and fixed dependency vulnerabilities"): updated RE…

    …ADME, package.json
    
    Updated README to include more context, updated the Create new docs flow so it doesn't refer to
    forking, ran npm audit fix to start to address vulnerabilities.
    mapachurro authored and mapachurro committed Jun 1, 2023
    Copy the full SHA
    cd93cb8 View commit details

Commits on Jun 3, 2023

  1. Copy the full SHA
    66383ab View commit details

Commits on Jun 7, 2023

  1. Merge pull request #3 from ConsenSys/instructions

    Fix (updated README and fixed dependency vulnerabilities)
    joshuafernandes authored Jun 7, 2023
    1
    Copy the full SHA
    6b60e17 View commit details
  2. chore(release): 1.18.4

    ## [1.18.4](v1.18.3...v1.18.4) (2023-06-07)
    
    ### Bug Fixes
    
    * **updated readme and fixed dependency vulnerabilities":** updated README, package.json ([cd93cb8](cd93cb8))
    semantic-release-bot committed Jun 7, 2023
    1
    Copy the full SHA
    969b332 View commit details
  3. Copy the full SHA
    eab16e9 View commit details
  4. fix: npm fix

    joshuafernandes committed Jun 7, 2023
    1
    Copy the full SHA
    c1c9ca1 View commit details
  5. chore(release): 1.19.0

    # [1.19.0](v1.18.4...v1.19.0) (2023-06-07)
    
    ### Bug Fixes
    
    * npm fix ([c1c9ca1](c1c9ca1))
    
    ### Features
    
    * doc content re algolia scraper ([eab16e9](eab16e9))
    semantic-release-bot committed Jun 7, 2023
    1
    Copy the full SHA
    ab0c269 View commit details
  6. docusaurus guide

    alexandratran committed Jun 7, 2023
    Copy the full SHA
    24f60b8 View commit details

Commits on Jun 8, 2023

  1. Copy the full SHA
    f9e54f1 View commit details
  2. Merge branch 'main' into update-guidelines

    # Conflicts:
    #	docs/create/set-up-your-site.md
    alexandratran committed Jun 8, 2023
    Copy the full SHA
    f391d6a View commit details
  3. Copy the full SHA
    85ef10d View commit details

Commits on Jun 12, 2023

  1. fix lint errors

    alexandratran committed Jun 12, 2023
    Copy the full SHA
    b5b7cd8 View commit details

Commits on Jun 19, 2023

  1. edit more pages

    alexandratran committed Jun 19, 2023
    Copy the full SHA
    32b444c View commit details

Commits on Jun 20, 2023

  1. finish edits

    alexandratran committed Jun 20, 2023
    Copy the full SHA
    343de48 View commit details
  2. minor fixes

    alexandratran committed Jun 20, 2023
    Copy the full SHA
    21b1a8c View commit details
  3. Copy the full SHA
    7b69d07 View commit details
  4. Merge pull request #2 from ConsenSys/update-guidelines

    Update site content and configuration
    joshuafernandes authored Jun 20, 2023
    1
    Copy the full SHA
    6fe26fc View commit details

Commits on Jun 23, 2023

  1. Update site

    alexandratran committed Jun 23, 2023
    Copy the full SHA
    60a9c42 View commit details
  2. minor fix

    alexandratran committed Jun 23, 2023
    Copy the full SHA
    392f075 View commit details
  3. fix link

    alexandratran committed Jun 23, 2023
    Copy the full SHA
    7e8cd90 View commit details
  4. reviewer suggestion

    alexandratran committed Jun 23, 2023
    Copy the full SHA
    347ac13 View commit details
  5. Merge pull request #4 from ConsenSys/updates

    Update site
    alexandratran authored Jun 23, 2023
    1
    Copy the full SHA
    371e223 View commit details
  6. 1
    Copy the full SHA
    7a96bda View commit details

Commits on Jun 26, 2023

  1. Update guide

    alexandratran committed Jun 26, 2023
    Copy the full SHA
    6f9f031 View commit details
  2. Minor edit

    alexandratran committed Jun 26, 2023
    Copy the full SHA
    177d7e6 View commit details

Commits on Jul 5, 2023

  1. minor fix

    alexandratran committed Jul 5, 2023
    Copy the full SHA
    72576f3 View commit details
  2. Merge pull request #5 from Consensys/updates

    Update guide
    alexandratran authored Jul 5, 2023
    1
    Copy the full SHA
    9bbf9ee View commit details

Commits on Jul 31, 2023

  1. Add release process for versioned docs.

    Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
    bgravenorst committed Jul 31, 2023
    Copy the full SHA
    f37667f View commit details

Commits on Aug 1, 2023

  1. fusing the version docs in the versions page

    Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net>
    joshuafernandes committed Aug 1, 2023
    Copy the full SHA
    7cc1097 View commit details

Commits on Aug 4, 2023

  1. Copy the full SHA
    1f5e1cb View commit details
  2. Update docs/contribute/preview.md

    Co-authored-by: Alexandra Tran Carrillo <12214231+alexandratran@users.noreply.github.com>
    mjsmike62 and alexandratran authored Aug 4, 2023
    Copy the full SHA
    88b8203 View commit details
  3. Merge pull request #8 from mjsmike62/7-create-note-prev-dev-ver

    Add note about previewing development version
    alexandratran authored Aug 4, 2023
    1
    Copy the full SHA
    77315b3 View commit details

Commits on Aug 28, 2023

  1. Minor updates.

    Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
    bgravenorst committed Aug 28, 2023
    Copy the full SHA
    f818537 View commit details
  2. Merge pull request #6 from Consensys/addReleaseProcess

    Add release process for versioned docs.
    bgravenorst authored Aug 28, 2023
    1
    Copy the full SHA
    8fa1899 View commit details

Commits on Sep 26, 2023

  1. 1
    Copy the full SHA
    a7d644d View commit details

Commits on Oct 7, 2023

  1. chore(deps): bump postcss from 8.4.24 to 8.4.31

    Bumps [postcss](https://github.com/postcss/postcss) from 8.4.24 to 8.4.31.
    - [Release notes](https://github.com/postcss/postcss/releases)
    - [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md)
    - [Commits](postcss/postcss@8.4.24...8.4.31)
    
    ---
    updated-dependencies:
    - dependency-name: postcss
      dependency-type: indirect
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    dependabot[bot] authored Oct 7, 2023
    Copy the full SHA
    f60b883 View commit details

Commits on Oct 9, 2023

  1. Merge pull request #11 from Consensys/dependabot/npm_and_yarn/postcss…

    …-8.4.31
    
    chore(deps): bump postcss from 8.4.24 to 8.4.31
    alexandratran authored Oct 9, 2023
    1
    Copy the full SHA
    f6a3491 View commit details

Commits on Oct 19, 2023

  1. chore(deps): bump @babel/traverse from 7.22.4 to 7.23.2

    Bumps [@babel/traverse](https://github.com/babel/babel/tree/HEAD/packages/babel-traverse) from 7.22.4 to 7.23.2.
    - [Release notes](https://github.com/babel/babel/releases)
    - [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md)
    - [Commits](https://github.com/babel/babel/commits/v7.23.2/packages/babel-traverse)
    
    ---
    updated-dependencies:
    - dependency-name: "@babel/traverse"
      dependency-type: indirect
    ...
    
    Signed-off-by: dependabot[bot] <support@github.com>
    dependabot[bot] authored Oct 19, 2023
    Copy the full SHA
    8cfa79c View commit details
  2. Merge pull request #12 from Consensys/dependabot/npm_and_yarn/babel/t…

    …raverse-7.23.2
    
    chore(deps): bump @babel/traverse from 7.22.4 to 7.23.2
    alexandratran authored Oct 19, 2023
    1
    Copy the full SHA
    4b755a2 View commit details

Commits on Oct 27, 2023

  1. 1
    Copy the full SHA
    9c1ce3d View commit details
  2. 1
    Copy the full SHA
    2f19b46 View commit details

Commits on Nov 1, 2023

  1. upgrade to 3

    joshuafernandes committed Nov 1, 2023
    Copy the full SHA
    3cfed2e View commit details

Commits on Nov 22, 2023

  1. Copy the full SHA
    7b518e9 View commit details
  2. Merge pull request #1 from ATREAY/docs

    Updated link to doc.web3signer
    ATREAY authored Nov 22, 2023
    Copy the full SHA
    3a184d2 View commit details
  3. Update docs/index.md

    alexandratran authored Nov 22, 2023
    Copy the full SHA
    6cda282 View commit details
  4. Merge pull request #17 from ATREAY/main

    Updated link to doc.web3signer
    alexandratran authored Nov 22, 2023
    1
    Copy the full SHA
    c97998d View commit details
Showing with 20,409 additions and 17,388 deletions.
  1. +0 −45 .cspell.json
  2. +4 −1 .editorconfig
  3. +1 −0 .eslintignore
  4. +10 −81 .eslintrc.js
  5. +0 −25 .github/ISSUE_TEMPLATE/bug_report.md
  6. +0 −45 .github/pull_request_template.md
  7. +55 −0 .github/workflows/algolia-search-scraper.yml
  8. +3 −5 .github/workflows/build.yml
  9. +4 −4 .github/workflows/case.yml
  10. +11 −0 .github/workflows/dependabot.yml
  11. +21 −0 .github/workflows/links.yml
  12. +7 −20 .github/workflows/lint.yml
  13. +1 −1 .github/workflows/release.yaml
  14. +22 −0 .github/workflows/spelling.yml
  15. +18 −0 .github/workflows/trivy.yml
  16. +2 −0 .gitignore
  17. +0 −4 .husky/commit-msg
  18. +0 −4 .husky/pre-commit
  19. +0 −4 .husky/prepare-commit-msg
  20. +1 −1 .nvmrc
  21. +8 −16 .stylelintrc.js
  22. +0 −307 CHANGELOG.md
  23. +1 −1 LICENSE
  24. +6 −15 README.md
  25. +0 −3 babel.config.js
  26. +0 −12 blog/2019-05-28-first-blog-post.md
  27. +0 −44 blog/2019-05-29-long-blog-post.md
  28. +0 −20 blog/2021-08-01-mdx-blog-post.mdx
  29. BIN blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg
  30. +0 −25 blog/2021-08-26-welcome/index.md
  31. +0 −17 blog/authors.yml
  32. +0 −8 docs/advanced/configuration-files/_category_.json
  33. +0 −12 docs/advanced/configuration-files/docusaurus-config.mdx
  34. +0 −88 docs/advanced/configuration-files/package.mdx
  35. +0 −91 docs/advanced/configuration-files/sidebars.mdx
  36. +0 −23 docs/advanced/cspell-check.md
  37. +0 −44 docs/advanced/disable-automatic-release.mdx
  38. +0 −111 docs/advanced/enabling-search.md
  39. +0 −43 docs/advanced/google-analytics.mdx
  40. +0 −56 docs/advanced/manage-docs-versions.md
  41. +0 −145 docs/advanced/production-deployment.md
  42. +0 −99 docs/advanced/remove-openapi-demo.mdx
  43. +0 −88 docs/advanced/translate-your-site.md
  44. BIN docs/assets/besu-tessera-high-availability.png
  45. BIN docs/assets/transaction-insights.png
  46. BIN docs/assets/use-vale.png
  47. BIN docs/assets/vale-ci.png
  48. BIN docs/assets/vs-code-ext.png
  49. +40 −0 docs/configure/google-analytics.md
  50. BIN docs/{advanced → configure}/img/docsVersionDropdown.png
  51. BIN docs/{advanced → configure}/img/localeDropdown.png
  52. +11 −0 docs/configure/openapi.md
  53. +128 −0 docs/configure/search.md
  54. +33 −0 docs/configure/spell-check.md
  55. +8 −0 docs/configure/versioning/_category_.json
  56. +60 −0 docs/configure/versioning/disable-automatic-release.md
  57. +209 −0 docs/configure/versioning/index.md
  58. +11 −4 docs/{advanced/multi-instance-docs.mdx → configure/versioning/support-multi-instance-docs.md}
  59. +198 −0 docs/contribute/add-images.md
  60. +291 −0 docs/contribute/format-markdown.md
  61. +36 −0 docs/contribute/preview.md
  62. +41 −0 docs/contribute/review-contributions.md
  63. +92 −0 docs/contribute/run-vale.md
  64. +158 −0 docs/contribute/style-guide.md
  65. +114 −0 docs/contribute/submit-a-contribution.md
  66. +266 −0 docs/create/configure-docusaurus.md
  67. +158 −0 docs/create/deploy-to-production.md
  68. BIN docs/{getting-started → create}/img/commit.gif
  69. BIN docs/{getting-started → create}/img/createNewRepository.png
  70. BIN docs/{advanced → create}/img/privateRepoVercel.png
  71. BIN docs/{advanced → create}/img/privateRepoVercelSettings.png
  72. BIN docs/{getting-started → create}/img/useThisTemplate.png
  73. BIN docs/{advanced → create}/img/vercelGithubComment.png
  74. +236 −0 docs/create/repo-structure.md
  75. +128 −0 docs/create/run-in-development.md
  76. +73 −0 docs/create/set-up-your-site.md
  77. +0 −105 docs/getting-started/index.mdx
  78. +0 −152 docs/getting-started/running-workflow.mdx
  79. +0 −57 docs/getting-started/style-guide.mdx
  80. +0 −262 docs/getting-started/understanding-repo-layout.mdx
  81. +53 −0 docs/index.md
  82. +121 −171 docusaurus.config.js
  83. +17,693 −14,219 package-lock.json
  84. +31 −43 package.json
  85. +0 −588 project-words.txt
  86. +23 −4 sidebars.js
  87. +0 −101 src/components/HomepageCards/index.tsx
  88. +0 −70 src/components/HomepageFeatures/index.tsx
  89. +0 −11 src/components/HomepageFeatures/styles.module.css
  90. +20 −0 src/css/custom.css
  91. +0 −40 src/pages/index.module.css
  92. +0 −51 src/pages/index.tsx
  93. +2 −2 tsconfig.json
45 changes: 0 additions & 45 deletions .cspell.json

This file was deleted.

5 changes: 4 additions & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
@@ -8,9 +8,12 @@ end_of_line = lf
insert_final_newline = true
indent_style = space
indent_size = 2
max_line_length = 80
max_line_length = 100
trim_trailing_whitespace = true

[*.md]
max_line_length = 80
indent_style = space

insert_final_newline = false
trim_trailing_whitespace = false
1 change: 1 addition & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
build/
.eslintrc.js
.eslintrc.md.js
docs/test-api
./node_modules/*
*.md
91 changes: 10 additions & 81 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -1,88 +1,17 @@
module.exports = {
env: {
browser: true,
es2021: true,
},
extends: [
"plugin:react/recommended",
"airbnb-typescript",
"plugin:import/typescript",
// @NOTE: Make sure this is always the last element in the array.
"plugin:prettier/recommended",
],
parser: "@typescript-eslint/parser",
parserOptions: {
ecmaVersion: 2020,
sourceType: "module",
ecmaFeatures: {
jsx: true,
},
project: ["./tsconfig.json"],
},
plugins: [
"react",
"react-hooks",
"jsx-a11y",
"import",
"prettier",
"@typescript-eslint",
"plugin:@docusaurus/recommended",
],
settings: {
react: {
pragma: "React", // Pragma to use, default to "React"
fragment: "Fragment", // Fragment to use (may be a property of <pragma>), default to "Fragment"
version: "detect", // React version. "detect" automatically picks the version you have installed.
// You can also use `16.0`, `16.3`, etc, if you want to override the detected value.
// default to latest and warns if missing
// It will default to "detect" in the future
},
"import/parsers": {
"@typescript-eslint/parser": [".ts", ".tsx"],
},
"import/resolver": {
typescript: {},
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaVersion": "latest",
"sourceType": "module",
"ecmaFeatures": {
"jsx": true
},
project: ["./tsconfig.json"]
},
rules: {
"import/prefer-default-export": 0,
"react/prop-types": 0,
"import/no-unresolved": [
"error",
{ ignore: ["^@theme", "^@docusaurus", "^@site"] },
],
"no-nested-ternary": 0,
"no-console": 0,
"no-unused-vars": 0,
"no-use-before-define": 0,
"arrow-body-style": 0,
"jsx-a11y/anchor-is-valid": 0,
"jsx-a11y/no-static-element-interactions": 0,
"jsx-a11y/click-events-have-key-events": 0,
"@typescript-eslint/no-unused-expressions": 0,
"@typescript-eslint/no-unused-vars": ["warn", { args: "none" }],
"@typescript-eslint/no-use-before-define": "warn",
"react/require-default-props": 0,
"react/jsx-props-no-spreading": 0,
"react/button-has-type": 0,
"jsx-a11y/label-has-associated-control": [
"error",
{
labelComponents: [],
labelAttributes: [],
controlComponents: [],
assert: "either",
depth: 2,
},
],
"@typescript-eslint/naming-convention": [
"error",
{
selector: "variableLike",
leadingUnderscore: "forbid",
trailingUnderscore: "forbid",
format: ["camelCase", "PascalCase", "UPPER_CASE"],
},
],
"import/extensions": 0,
'@docusaurus/no-untranslated-text': 0
},
};
};
25 changes: 0 additions & 25 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

45 changes: 0 additions & 45 deletions .github/pull_request_template.md

This file was deleted.

55 changes: 55 additions & 0 deletions .github/workflows/algolia-search-scraper.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Algolia Search Scraper

on:
schedule:
- cron: "0 8 * * *"
workflow_dispatch:

jobs:
build:
name: Trigger Algolia Scraper
runs-on: ubuntu-22.04
environment: algolia
strategy:
fail-fast: false
matrix:
version:
[
"docs",
]
steps:
- uses: actions/checkout@v3
- id: config
name: Read ${{ matrix.version }}.json
shell: bash
run: |
content=$(cat ./.github/config/${{ matrix.version }}.json | jq -r tostring)
echo "configJSON=$content" >> $GITHUB_OUTPUT
- name: Checkout algolia/docsearch-scraper
uses: actions/checkout@v3
with:
repository: algolia/docsearch-scraper
path: "./algolia"
- name: Set up Python
uses: actions/setup-python@v4.5.0
with:
python-version: "3.6"
- name: Install pipenv
shell: bash
run: |
pip install pipenv
- name: pipenv Pipfile
shell: bash
run: |
cd ./algolia
pipenv install
- name: run algolia
shell: bash
env:
APPLICATION_ID: ${{ secrets.APPLICATION_ID }}
API_KEY: ${{ secrets.API_KEY }}
CONFIG: ${{ steps.config.outputs.configJSON }}
run: |
cd ./algolia/scraper
pipenv run python -m src.index
8 changes: 3 additions & 5 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -2,12 +2,10 @@
name: Build

on:
workflow_call:
pull_request:
branches:
- main
workflow_call:
# 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:
@@ -16,9 +14,9 @@ jobs:
permissions:
contents: read
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- name: Build
uses: ConsenSys/docs-gha/build@main
uses: ConsenSys/github-actions/docs-build@main
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
8 changes: 4 additions & 4 deletions .github/workflows/case.yml
Original file line number Diff line number Diff line change
@@ -5,22 +5,22 @@ on:
pull_request:
branches:
- main
workflow_call:

jobs:
case:
name: Check for case being inconsistent
runs-on: ubuntu-latest
strategy:
matrix:
folder: ["docs", "blog"]
folder: ["docs"]
permissions:
contents: read
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- name: Case check action
uses: ConsenSys/docs-gha/case@main
uses: ConsenSys/github-actions/docs-case-check@main
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DOC_DIR: ${{ matrix.folder }}
SKIP_TEST: true
11 changes: 11 additions & 0 deletions .github/workflows/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: 'Dependency Review'

version: 2
updates:
- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "weekly"
day: "sunday"
assignees:
- "protocol-galileo"
21 changes: 21 additions & 0 deletions .github/workflows/links.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Check for broken links

on:
pull_request:
branches:
- main

jobs:
linkCheck:
name: Link Checking
runs-on: ubuntu-latest
strategy:
matrix:
file-extensions: [".md", ".mdx"]
steps:
- uses: actions/checkout@v4
- name: LinkCheck
uses: ConsenSys/github-actions/docs-link-check@main
with:
FILE_EXTENSION: ${{ matrix.file-extensions }}
Loading