Add issue templates and update contribution guidelines (#331)

* Add issue templates and update contribution guidelines * Fix incorrect return type * Try to fix an error * Fix errors * Fix vale errors * Update nextra-feedback.yml * Update nextra-feedback.yml * Update nextra-feedback.yml * Update resource-hub-submission.yml * Update resource-hub-submission.yml * Update resource-hub-submission.yml * Update resource-hub-submission.yml * Update resource-hub-submission.yml * Update resource-hub-submission.yml * Fix something * Update resource-hub-submission.yml * Remove protocol from resource tags; Capitalize Blog Posts * Update .github/ISSUE_TEMPLATE/nextra-feedback.yml Co-authored-by: Germán Martínez <[email protected]> * Update .github/ISSUE_TEMPLATE/resource-hub-submission.yml Co-authored-by: Germán Martínez <[email protected]> * Update .github/ISSUE_TEMPLATE/resource-hub-submission.yml Co-authored-by: Germán Martínez <[email protected]> --------- Co-authored-by: Tanay Pant <tanaypantprotonmail.com> Co-authored-by: louis-md <[email protected]> Co-authored-by: Germán Martínez <[email protected]>
safe-global · Feb 1, 2024 · 72ed63b · 72ed63b
1 parent 732b159
commit 72ed63b
Show file tree

Hide file tree

Showing 7 changed files with 116 additions and 27 deletions.
diff --git a/.github/ISSUE_TEMPLATE/nextra-feedback.yml b/.github/ISSUE_TEMPLATE/nextra-feedback.yml
@@ -0,0 +1,29 @@
+name: Nextra Feedback
+description: Report errors you find in our documentation or ideas for enhancing our documentation.
+title: "[Feedback]: "
+labels: ["nextra-feedback"]
+body:
+  - type: textarea
+    validations:
+      required: true
+    attributes:
+      label: Feedback
+      description: |
+        What is the error you found in our documentation or what do you think should be enhanced?
+  - type: textarea
+    validations:
+      required: false
+    attributes:
+      label: How can this issue be resolved?
+      description: If you have an idea of how the issue can be resolved, please detail the steps below.
+      value: |
+        1.
+        2.
+        3.
+  - type: checkboxes
+    attributes:
+      label: Are you interested in working on this?
+      description: If you're interested in not only reporting this issue but also fix it, check the box below.
+      options:
+        - label: "I would like to implement/fix this issue"
+          required: false
diff --git a/.github/ISSUE_TEMPLATE/resource-hub-submission.yml b/.github/ISSUE_TEMPLATE/resource-hub-submission.yml
@@ -0,0 +1,53 @@
+name: Resource Hub Submission
+description: Suggest a resource to add to our resource hub.
+labels: ["resource-hub"]
+title: "[Resource Hub]: "
+body:
+  - type: checkboxes
+    attributes:
+      label: Checklist
+      description: Please make sure that you verify each checkbox and follow the instructions for them.
+      options:
+        - label: "This resource is not a duplicate. Before opening a new issue, please search existing issues and the Resource Hub."
+          required: true
+        - label: "This resource is related to Safe{Core} and is educational in nature."
+          required: true
+        - label: "This resource is not promotional in nature."
+          required: true
+  - type: input
+    attributes:
+      label: Link
+      description: The URL of the resource.
+    validations:
+      required: true
+  - type: dropdown
+    attributes:
+      label: Type
+      description: The type of resource.
+      options:
+        - Blog Post
+        - Podcast
+        - Video
+    validations:
+      required: true
+  - type: checkboxes
+    attributes:
+      label: Tags
+      description: Select some tags for your resource.
+      options:
+        - label: Account Abstraction
+        - label: Deep Dive
+        - label: Gasless Transactions
+        - label: Guards
+        - label: Hardhat
+        - label: Introduction
+        - label: Mass Adoption
+        - label: Modules
+        - label: Tutorial
+        - label: Perspectives
+        - label: Plugins
+        - label: Safe Core SDK
+        - label: Safe Transaction Service
+        - label: Safe Wallet
+        - label: Safe Smart Account
+        - label: Security
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,6 +4,10 @@ Thank you for contributing to the Safe docs. Before starting, please review the
 
 We use the [Microsoft Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/) for the styles and [Vale](https://vale.sh/docs/) for linting. This combination helps us use the style guide effectively.
 
+## Submitting to Resource Hub
+
+Please open an [issue](https://github.com/safe-global/safe-docs/issues/new?template=resource-hub-submission.yml) to submit a resource to our Resource Hub.
+
 ## Using Vale
 
 Install the [Vale CLI](https://vale.sh/docs/vale-cli/installation/) and run the following command: 

diff --git a/components/ResourceHub/community-resources.json b/components/ResourceHub/community-resources.json
@@ -14,7 +14,7 @@
     "type": "Video",
     "tags": [
       "Introduction",
-      "Protocol"
+      "Safe Smart Account"
     ]
   },
   {
@@ -86,7 +86,7 @@
     "type": "Video",
     "tags": [
       "Deep Dive",
-      "Protocol"
+      "Safe Smart Account"
     ]
   },
   {
@@ -95,7 +95,7 @@
     "type": "Video",
     "tags": [
       "Deep Dive",
-      "Protocol"
+      "Safe Smart Account"
     ]
   },
   {
@@ -104,7 +104,7 @@
     "type": "Video",
     "tags": [
       "Tutorial",
-      "Protocol",
+      "Safe Smart Account",
       "Gasless Transactions"
     ]
   },
@@ -114,24 +114,24 @@
     "type": "Video",
     "tags": [
       "Tutorial",
-      "Protocol",
+      "Safe Smart Account",
       "Hardhat"
     ]
   },
   {
     "name": "Safe Study (Japanese)",
     "url": "https://zenn.dev/kozayupapa/articles/877ca3c93fc4a9",
-    "type": "Blog post",
+    "type": "Blog Post",
     "abstract": "ERC-4337(AccountAbstraction) 等のライブラリを提供しているSafeについて理解を深めるため、下記のドキュメントを要約していきたいとおもいます。",
     "tags": [
       "Tutorial",
-      "Protocol"
+      "Safe Smart Account"
     ]
   },
   {
     "name": "How to Multi-Distribute ERC-20 tokens via Safe Core SDK",
     "url": "https://mirror.xyz/0xa1AC2cC82249A44892802a99CA84c4ed1072B29C/lL8AYV_b4VzTbojuZEprrxD7-RTTap2IMIS8qIObfl8",
-    "type": "Blog post",
+    "type": "Blog Post",
     "abstract": "As part of the Atem.green project I’m helping to build, we want to incentivize early contributors by handing out (pre-launch) ERC-20 tokens. We use Coordinape to determine the impact every contributor has in a given month. From that we can calculate how many (pre-launch) token each contributor earned. Now the question is: How do we distribute these tokens?",
     "tags": [
       "Tutorial",
@@ -141,7 +141,7 @@
   {
     "name": "Build a treasury wallet with multisignature Safe",
     "url": "https://blog.logrocket.com/build-treasury-wallet-multisignature-gnosis-safe/",
-    "type": "Blog post",
+    "type": "Blog Post",
     "abstract": "Imagine you and your friends are building an NFT marketplace. You are the CEO and your friend works as a Solidity engineer who writes the smart contract. The NFT marketplace becomes popular, and your revenue builds from the market fee of every NFT sale transaction. You store your profit inside a smart contract, and boast to the media about your company that has enough money to buy a private island. Then, the Solidity engineer disappears and withdraws all the funds from the treasury. You watch in horror.",
     "tags": [
       "Tutorial",

diff --git a/components/ResourceHub/company-resources.json b/components/ResourceHub/company-resources.json
@@ -42,7 +42,7 @@
     "url": "https://www.youtube.com/watch?v=EzAL1A5N_6k",
     "type": "Video",
     "tags": [
-      "Protocol",
+      "Safe Smart Account",
       "Plugins"
     ]
   },
@@ -51,7 +51,7 @@
     "url": "https://www.youtube.com/watch?v=6LpRecrNqFk",
     "type": "Video",
     "tags": [
-      "Protocol"
+      "Safe Smart Account"
     ]
   },
   {
@@ -92,7 +92,7 @@
   {
     "name": "Get the most secure web3 account in <30 seconds",
     "url": "https://safe.mirror.xyz/pyf0meKAyooY1v8GB7z6Ik7o4wPHGTyCOcUf--UU-IA",
-    "type": "Blog post",
+    "type": "Blog Post",
     "abstract": "Introducing self-custody for everyone. From today, you can secure your crypto fast and free with Safe{Wallet} on Gnosis Chain using just your Google Account.",
     "tags": [
       "Tutorial",
@@ -102,7 +102,7 @@
   {
     "name": "The new AI agent economy will run on Smart Accounts.",
     "url": "https://safe.mirror.xyz/V965PykKzlE1PCuWxBjsCJR12WscLcnMxuvR9E9bP-Y",
-    "type": "Blog post",
+    "type": "Blog Post",
     "abstract": "Web3’s first billion users may not only be humans, but AI agents.",
     "tags": [
       "Perspectives",
@@ -112,39 +112,39 @@
   {
     "name": "Enhancing Blockchain Security with ERC-7512: A Standard for representing smart contract audits onchain",
     "url": "https://safe.mirror.xyz/Li4Mb4teTEmosE6dAsnJ_iz3aMKOV_4lDU84W4TSfc0",
-    "type": "Blog post",
+    "type": "Blog Post",
     "abstract": "In a significant stride towards fortifying blockchain security, we at Safe, along with top security experts have introduced ERC-7512, a standard for onchain audit report representations.",
     "tags": [
-      "Protocol",
+      "Safe Smart Account",
       "Security"
     ]
   },
   {
     "name": "Introducing Safe{Core} Protocol: Solving the wicked problem of smart accounts",
     "url": "https://safe.mirror.xyz/KiklifJINUpklBzf-usK_54EC86AfSeX5wH89bNxglM",
-    "type": "Blog post",
+    "type": "Blog Post",
     "abstract": "Today, we are introducing a whitepaper for a modular, open-source Safe{Core} Protocol aiming to advance the smart account transition.",
     "tags": [
       "Introduction",
-      "Protocol",
+      "Safe Smart Account",
       "Account Abstraction"
     ]
   },
   {
     "name": "Safe Modular Smart Account Architecture – Explained",
     "url": "https://safe.mirror.xyz/t76RZPgEKdRmWNIbEzi75onWPeZrBrwbLRejuj-iPpQ",
-    "type": "Blog post",
+    "type": "Blog Post",
     "abstract": "Safe is at the forefront of modular Smart Account infrastructure, paving the way for developers to create a diverse range of applications and wallets.",
     "tags": [
       "Deep Dive",
       "Account Abstraction",
-      "Protocol"
+      "Safe Smart Account"
     ]
   },
   {
     "name": "Launching Monerium on Safe{Core}: Connecting Safes to Euro IBAN accounts",
     "url": "https://safe.mirror.xyz/4pgiJAEQ2Jt0ij9Ezc8FSOSiRSfVY4Im8FZ0LuICx-8",
-    "type": "Blog post",
+    "type": "Blog Post",
     "abstract": "Today, the Safe{Core} Account Abstraction SDK added a shiny new tool to its toolbox.",
     "tags": [
       "Introduction",
@@ -154,7 +154,7 @@
   {
     "name": "Redefine security with new Safe{Wallet} transaction risk scanner",
     "url": "https://safe.mirror.xyz/rInLWZwD_sf7enjoFerj6FIzCYmVMGrrV8Nhg4THdwI",
-    "type": "Blog post",
+    "type": "Blog Post",
     "abstract": "We’re excited to bring you news of an important enhancement to your transactional security.",
     "tags": [
       "Security",
@@ -164,18 +164,18 @@
   {
     "name": "Safe Smart Accounts & Diamond Proxies",
     "url": "https://safe.mirror.xyz/P83_rVQuUQJAM-SnMpWvsHlN8oLnCeSncD1txyMDqpE",
-    "type": "Blog post",
+    "type": "Blog Post",
     "abstract": "Safe is a modular Smart Account protocol that uses Account Abstraction to build a wide range of wallets and other solutions through a shared plugin interface.",
     "tags": [
       "Deep Dive",
-      "Protocol",
+      "Safe Smart Account",
       "Account Abstraction"
     ]
   },
   {
     "name": "Account Abstraction in a Multichain Landscape - Part 1: Addresses",
     "url": "https://safe.mirror.xyz/4GcGAOFno-suTCjBewiYH4k4yXPDdIukC5woO5Bjc4w",
-    "type": "Blog post",
+    "type": "Blog Post",
     "abstract": "This is the first article in a series of posts exploring account abstraction in a multichain landscape.",
     "tags": [
       "Deep Dive",
@@ -185,7 +185,7 @@
   {
     "name": "Launching Safe{Core} Account Abstraction Stack with Stripe, Gelato and Web3Auth",
     "url": "https://safe.mirror.xyz/FLvQQ5J9qXks0izRl73oC6LiFLofbwFNorwzaEj_xL8",
-    "type": "Blog post",
+    "type": "Blog Post",
     "abstract": "Safe is launching Safe{Core}, a modular AA stack with Stripe, Gelato, and Web3Auth as launch partners.",
     "tags": [
       "Introduction",
@@ -196,7 +196,7 @@
   {
     "name": "Take Back Ownership Manifesto",
     "url": "https://safe.mirror.xyz/tO26nZ4CruKCS8d49pyModJhzHw1TTm2QcMqx2lYaXQ",
-    "type": "Blog post",
+    "type": "Blog Post",
     "abstract": "Not your keys, not your coins.",
     "tags": [
       "Perspectives",

diff --git a/package.json b/package.json
@@ -6,7 +6,7 @@
     "dev": "next dev",
     "generate-supported-networks": "node .github/scripts/generateSupportedNetworks.js",
     "linkcheck": "find ./pages -name '*.md*' -print0 | xargs -0 -n1 pnpm markdown-link-check --quiet --progress --config linkchecker-config.json",
-    "lint": "eslint . && vale . --minAlertLevel=error",
+    "lint": "eslint . && vale pages/ --minAlertLevel=error",
     "start": "serve out",
     "test": "env-cmd cypress run --headless",
     "typecheck": "tsc --noEmit --incremental false",

diff --git a/theme.config.tsx b/theme.config.tsx
@@ -23,6 +23,9 @@ const config: DocsThemeConfig = {
   sidebar: {
     defaultMenuCollapseLevel: 1
   },
+  feedback: {
+    useLink: () => { return 'https://github.com/safe-global/safe-docs/issues/new?template=nextra-feedbck.yml' }
+  },
   head: <link rel='icon' type='image/png' sizes='32x32' href='/favicon.png' />,
   useNextSeoProps: () => {
     const { asPath } = useRouter()