Release (#108)

# Description

Merge staging into main for release

BREAKING CHANGE

---------

Co-authored-by: Dustin Brickwood <dustinbrickwood204@gmail.com>
Co-authored-by: zksync-admin-bot2 <91326834+zksync-admin-bot2@users.noreply.github.com>
Co-authored-by: zksync-admin-bot2 <temp-bot@matterlabs.dev>
Co-authored-by: Antonio <tonioufa@gmail.com>
Co-authored-by: cpb8010 <cpb8010@users.noreply.github.com>
Co-authored-by: bxpana <42230936+bxpana@users.noreply.github.com>
Co-authored-by: albicodes <albionahh@outlook.com>
Co-authored-by: Artem Melnytskyi <112873874+amelnytskyi@users.noreply.github.com>
Co-authored-by: Nicolas Villanueva <nicolasvillanueva@msn.com>

.editorconfig

@@ -0,0 +1,11 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_size = 2
+indent_style = space
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = off

.env.example

@@ -0,0 +1,2 @@
+# Production license for @nuxt/ui-pro, get one at https://ui.nuxt.com/pro/purchase
+NUXT_UI_PRO_LICENSE=

.firebaserc

@@ -0,0 +1,7 @@
+{
+  "projects": {
+    "default": "zksync-docs-staging-5eb09",
+    "prod": "zksync-docs"
+  },
+  "etags": {}
+}

.github/CODEOWNERS

@@ -0,0 +1,10 @@
+# This CODEOWNERS file sets the individuals responsible for code in the era-test-node repository.
+
+# These users are the default owners for everything in the repo.
+# They will be requested for review when someone opens a pull request.
+* @matter-labs/devxp
+
+# You can also specify code owners for specific directories or files.
+# For example:
+# /src/ @developer1 @developer2
+# /docs/ @documenter

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,47 @@
+name: Bug Report
+description: File a bug report.
+title: "[Bug]: "
+labels: ["bug", "triage"]
+assignees:
+  - matter-labs/devxp
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to fill out this bug report! Please fill out as much as you can, the more details the better we can help to resolve the issue.
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Also tell us, what did you expect to happen?
+      placeholder: Tell us what you see!
+    validations:
+      required: true
+  - type: textarea
+    id: expected
+    attributes:
+      label: What did you expect to happen?
+      placeholder: Tell us what you expected!
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment
+      description: Please share any relevant information about your environment.
+      placeholder: |
+        - Operating System: [e.g. macOS]
+        - Node version: [e.g., v18.17.0]
+        - Other relevant environment details:
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/matter-labs/zksync-docs/blob/main/CODE_OF_CONDUCT.md).
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+    - name: zksync-developers Discussion
+      url: https://github.com/zkSync-Community-Hub/zkync-developers/discussions
+      about: These forms are for zkSync Docs related issues. If you have questions or need help, please visit the zksync-developers Discussion.

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,31 @@
+name: Feature Request
+description: Is there a feature missing you would like to see? Let us know!
+title: "[Feature]: "
+labels: ["feature", "triage"]
+assignees:
+  - matter-labs/devxp
+body:
+  - type: markdown
+    attributes:
+      value: |
+        If you have a feature you'd like to see, please fill out this form.
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Please provide a brief description of the feature you would like to see.
+      placeholder: Tell us what you would like to see!
+  - type: textarea
+    id: rationale
+    attributes:
+      label: Rationale
+      description: Why do you think this feature would be beneficial to the project?
+      placeholder: Tell us why you think this feature would be beneficial!
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/matter-labs/zksync-docs/blob/main/CODE_OF_CONDUCT.md).
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

.github/ISSUE_TEMPLATE/feedback.yml

@@ -0,0 +1,31 @@
+name: Feedback
+description: Please share any feedback for us on our content!
+title: "[Feedback]: "
+labels: ["feedback", "triage"]
+assignees:
+  - matter-labs/devxp
+body:
+  - type: markdown
+    attributes:
+      value: |
+        If you have feedback on our content, please fill out this form.
+  - type: input
+    id: page
+    attributes:
+      label: Page
+      description: If this is related to a specific page, please provide the URL.
+      placeholder: https://docs.zksync.io/page
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: Please provide a brief description of the feedback you would like to share.
+      placeholder: Tell us what you would like to share!
+  - type: checkboxes
+    id: terms
+    attributes:
+      label: Code of Conduct
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/matter-labs/zksync-docs/blob/main/CODE_OF_CONDUCT.md).
+      options:
+        - label: I agree to follow this project's Code of Conduct
+          required: true

.github/pull_request_template.md

@@ -0,0 +1,26 @@
+<!--
+
+Thank you for contributing to the zkSync Docs!
+
+Before submitting the PR, please make sure you do the following:
+
+- Update your PR title to follow [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
+- Read the [Contributing Guide](https://github.com/matter-labs/zksync-docs/blob/main/CONTRIBUTING.md).
+- Understand our [Code of Conduct](https://github.com/matter-labs/zksync-docs/blob/main/CODE_OF_CONDUCT.md)
+- Please delete any unused parts of the template when submitting your PR
+
+-->
+
+# Description
+
+<!-- Please describe what are the changes and what they are solving for in this PR. -->
+
+## Linked Issues
+
+<!-- If you have any issues this PR is related to, link them here. -->
+<!--
+Check out https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue
+on how to automate linking a GitHub Issue to a PR.
+-->
+
+## Additional context

.github/workflows/checks.yaml

@@ -0,0 +1,55 @@
+name: check 🕵️
+
+on:
+  pull_request:
+    branches: [main, staging]
+  workflow_dispatch:
+
+env:
+  HUSKY: 0
+  CI: true
+
+jobs:
+  format:
+    name: code_format
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@v1
+      - name: Install Dependencies
+        run: bun install
+      - name: Runs Prettier Formatter
+        run: bun run lint:prettier
+
+  spelling:
+    name: spelling
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@v1
+      - name: Install Dependencies
+        run: bun install
+      - name: Runs cSpell Spell Checker
+        run: bun run lint:spelling
+
+  markdown-lint:
+    name: markdown_lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@v1
+      - name: Install Dependencies
+        run: bun install
+      - name: Runs Markdown Linter
+        run: bun run lint:markdown
+
+  eslint:
+    name: code_lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@v1
+      - name: Install Dependencies
+        run: bun install
+      - name: Runs ESLint
+        run: bun run lint:eslint

.github/workflows/deploy-preview.yml

@@ -0,0 +1,35 @@
+name: "preview builder 👀"
+on:
+  pull_request:
+  workflow_dispatch:
+
+env:
+  NUXT_SITE_ENV: staging # used for NuxtSEO to disable things like indexing on staging
+  HUSKY: 0
+  CI: true
+
+jobs:
+  build_and_preview:
+    env:
+      NUXT_UI_PRO_LICENSE: ${{ secrets.NUXT_UI_PRO_LICENSE }}
+    if: ${{ github.event_name == 'workflow_dispatch' || github.event.pull_request.head.repo.full_name == github.repository }}
+    runs-on: ubuntu-latest
+    outputs:
+      output_urls: "${{ steps.preview_deploy.outputs.urls }}"
+    steps:
+      - uses: actions/checkout@v4 # v4
+
+      - uses: oven-sh/setup-bun@v1
+
+      - name: "Install dependencies"
+        run: bun install --production --frozen-lockfile
+
+      - name: "Deploy target: staging"
+        run: bun run build
+
+      - name: "Deploy preview"
+        uses: matter-labs/action-hosting-deploy@main
+        with:
+          repoToken: '${{ secrets.GITHUB_TOKEN }}'
+          firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT_ZKSYNC_DOCS_STAGING_5EB09 }}"
+          projectId: zksync-docs-staging-5eb09

.github/workflows/deploy-prod.yml

@@ -0,0 +1,38 @@
+name: "deploy 🚀"
+on:
+  push:
+    branches: [main]
+
+env:
+  HUSKY: 0
+  CI: true
+
+concurrency:
+  group: production
+  cancel-in-progress: true
+
+jobs:
+  build_and_deploy:
+    env:
+      NUXT_UI_PRO_LICENSE: ${{ secrets.NUXT_UI_PRO_LICENSE }}
+    if: ${{ github.event.repository.full_name == github.repository }}
+    runs-on: ubuntu-latest
+    environment: production
+    steps:
+      - uses: actions/checkout@v4 # v4
+        with:
+          persist-credentials: false # <--- checking this in commit context
+
+      - uses: oven-sh/setup-bun@v1
+
+      - name: "Install dependencies"
+        run: bun install --production --frozen-lockfile
+      - name: "Deploy target: staging"
+        run: bun run build
+
+      - uses: matter-labs/action-hosting-deploy@main
+        with:
+          repoToken: "${{ secrets.GITHUB_TOKEN }}"
+          firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT_ZKSYNC_DOCS }}"
+          projectId: zksync-docs
+          channelId: live

.github/workflows/deploy-staging.yml

@@ -0,0 +1,40 @@
+name: "deploy staging 🏗️"
+on:
+  push:
+    branches: [staging]
+  workflow_dispatch:
+
+env:
+  NUXT_SITE_ENV: staging # used for NuxtSEO to disable things like indexing on staging
+  HUSKY: 0
+  CI: true
+
+concurrency:
+  group: staging
+  cancel-in-progress: true
+
+jobs:
+  build_and_deploy:
+    env:
+      NUXT_UI_PRO_LICENSE: ${{ secrets.NUXT_UI_PRO_LICENSE }}
+    if: ${{ github.event.repository.full_name == github.repository }}
+    environment: staging
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4 # v4
+        with:
+          ref: "${{ github.event.inputs.ref }}"
+
+      - uses: oven-sh/setup-bun@v1
+
+      - name: "Install dependencies"
+        run: bun install --production --frozen-lockfile
+      - name: "Deploy target: staging"
+        run: bun run build
+
+      - uses: matter-labs/action-hosting-deploy@main
+        with:
+          repoToken: "${{ secrets.GITHUB_TOKEN }}"
+          firebaseServiceAccount: "${{ secrets.FIREBASE_SERVICE_ACCOUNT_ZKSYNC_DOCS_STAGING_5EB09 }}"
+          projectId: zksync-docs-staging-5eb09
+          channelId: live

.github/workflows/release.yml

@@ -0,0 +1,32 @@
+name: release 🚀
+
+on:
+  push:
+    branches: [ main ]
+
+env:
+  HUSKY: 0
+  CI: true
+
+jobs:
+  release:
+    if: ${{ github.event.repository.full_name == github.repository }} && {{ !contains(github.event.head_commit.message, "skip ci") }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4 # v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 'latest'
+      - uses: oven-sh/setup-bun@v1
+
+      - name: "Install dependencies"
+        run: bun install --production --frozen-lockfile
+
+      - name: "Release"
+        run: bunx semantic-release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/secrets_scanner.yaml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
+        uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
         with:
           fetch-depth: 0
       - name: TruffleHog OSS