chore(website,repo): add integration guide and update add to project (t…

…aikoxyz#14018)
ferfereh1 · Jun 21, 2023 · a5085a1 · a5085a1
1 parent f1c5222
commit a5085a1
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 1 deletion.
diff --git a/.github/ISSUE_TEMPLATE/add_project.yml b/.github/ISSUE_TEMPLATE/add_project.yml
@@ -28,6 +28,12 @@ body:
       label: Link to your project
     validations:
       required: true
+  - type: input
+    id: evidence
+    attributes:
+      label: Please provide evidence here that your project is integrated with Taiko for us to easily check.
+    validations:
+      required: true
   - type: textarea
     id: logo
     attributes:

diff --git a/packages/website/components/Footer.tsx b/packages/website/components/Footer.tsx
@@ -26,6 +26,14 @@ export default function Footer() {
                   Careers
                 </a>
               </li>
+              <li className="mb-4">
+                <a
+                  href="/docs/resources/integration-guide"
+                  className="hover:underline"
+                >
+                  Integration guide
+                </a>
+              </li>
               <li className="mb-4">
                 <a
                   href="https://github.com/taikoxyz/taiko-mono/tree/main/packages/branding/"

diff --git a/packages/website/pages/docs/resources/_meta.json b/packages/website/pages/docs/resources/_meta.json
@@ -2,6 +2,9 @@
   "contributing": {
     "title": "Contributing"
   },
+  "integration-guide": {
+    "title": "Integration guide"
+  },
   "official-links": {
     "title": "Official links"
   },

diff --git a/packages/website/pages/docs/resources/integration-guide.md b/packages/website/pages/docs/resources/integration-guide.md
@@ -0,0 +1,23 @@
+# Taiko integration guide
+
+Taiko is an Ethereum-equivalent network, meaning integrating with Taiko should be as simple as adding our RPC.
+
+## RPC configuration
+
+You can view the RPC configuration [here](/docs/reference/rpc-configuration).
+
+## Taiko brand assets
+
+When using the Taiko logo, please use one of the branding icons/logos [here](https://github.com/taikoxyz/taiko-mono/tree/main/packages/branding).
+
+## Add/update your project to our Ecosystem page
+
+Click **Add your project** on our Ecosystem page [here](/ecosystem).
+
+This will take you to a form where you can add/update details about your project. We will then handle the request and get it added to our page.
+
+## Additional support
+
+If you have any questions or are in need of any support to integrate Taiko, please reach out. We understand there may be more complex scenarios or questions in your integration, so we are here to help.
+
+You can message us / the community on Discord, and also contact a DevRel Engineer directly with the `@devrel` tag.
diff --git a/packages/website/pages/ecosystem.mdx b/packages/website/pages/ecosystem.mdx
@@ -2,6 +2,6 @@ import EcosystemSection from "components/EcosystemSection";
 
 {<h1 className="font-grotesk text-3xl mt-10 mb-4 text-center text-[2.5rem] tracking-tight text-neutral-900 dark:text-neutral-200">Ecosystem</h1>}
 
-{<p className="mb-16 text-center text-lg"><a href="https://github.com/taikoxyz/taiko-mono/issues/new?assignees=&labels=category.enhancement%2Cstatus.needs-triage&projects=&template=add_project.yml" target="_blank" rel="noopener noreferrer">Add your project</a></p>}
+{<p className="mb-16 text-center text-lg"><a href="https://github.com/taikoxyz/taiko-mono/issues/new?assignees=&labels=category.enhancement%2Cstatus.needs-triage&projects=&template=add_project.yml" target="_blank" rel="noopener noreferrer">Add/update your project</a></p>}
 
 <EcosystemSection />