Merge branch 'dev' into web3-integration

Author: corwintines

.env.example

@@ -7,6 +7,8 @@
 # NEXT_PUBLIC_ALGOLIA_APP_ID=insertValue
 # NEXT_PUBLIC_ALGOLIA_SEARCH_KEY=insertValue
 # NEXT_PUBLIC_ALGOLIA_BASE_SEARCH_INDEX_NAME=insertValue
+
+# Github token for read-only use with api functions
 # NEXT_PUBLIC_GITHUB_TOKEN_READ_ONLY=insertValue
 
 # Etherscan API key (required for Etherscan API fetches)

.eslintrc.json

@@ -33,8 +33,8 @@
           ["^@/data"],
           // From the `constants` directory.
           ["^@/lib/constants"],
-          // From the `.storybook/utils` file
-          ["^@/storybook-utils"],
+          // `.storybook` directory and utils files`
+          ["^@/storybook","^@/storybook-utils"],
           // Parent imports. Put `..` last.
           ["^\\.\\.(?!/?$)", "^\\.\\./?$"],
           // Other relative imports. Put same-folder imports and `.` last.

.github/ISSUE_TEMPLATE/suggest_resource.yaml

@@ -0,0 +1,63 @@
+name: Suggest a resource
+description: Suggest a new resource to list on ethereum.org/resources
+title: Suggest a resource
+labels: ["resource 📚"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Before suggesting a resource, make sure you've read [our listing policy](https://www.ethereum.org/en/contributing/adding-resources/).
+  - type: markdown
+    attributes:
+      value: Only continue with the issue if your resource meets the criteria listed there.
+  - type: markdown
+    attributes:
+      value: If it does, complete the following information which we need to accurately list the resource.
+  - type: markdown
+    id: resource_info
+    attributes:
+      value: "## Resource info"
+  - type: input
+    id: resource_name
+    attributes:
+      label: Name
+      description: Please provide the official name of the resource
+    validations:
+      required: true
+  - type: input
+    id: resource_url
+    attributes:
+      label: Resource URL
+      description: Please provide a URL to the resource
+    validations:
+      required: true
+  - type: textarea
+    id: resource_description
+    attributes:
+      label: Description
+      description: Please provide a short 1-2 sentence description of the resource
+    validations:
+      required: true
+  - type: textarea
+    id: resource_logo
+    attributes:
+      label: Logo
+      description: |
+        Please provide an SVG or transparent PNG
+        Tip: You can attach images by clicking this area to highlight it and then dragging files in.
+  - type: input
+    id: resource_category
+    attributes:
+      label: Category
+      description: Please specify a best fit to categorize the resource (e.g., DeFi, NFT, Scaling, etc.)
+  - type: checkboxes
+    id: resource_work_on
+    attributes:
+      label: Would you like to work on this issue?
+      options:
+        - label: "Yes"
+          required: false
+        - label: "No"
+          required: false
+    validations:
+      required: true

.storybook/main.ts

@@ -1,3 +1,5 @@
+import path from "path"
+
 import TsconfigPathsPlugin from "tsconfig-paths-webpack-plugin"
 import type { StorybookConfig } from "@storybook/nextjs"
 
@@ -51,6 +53,11 @@ const config: StorybookConfig = {
           extensions: config.resolve.extensions,
         }),
       ]
+
+      config.resolve.alias = {
+        ...config.resolve.alias,
+        "@/storybook/*": path.resolve(__dirname, "./.storybook/"),
+      }
     }
 
     // This modifies the existing image rule to exclude .svg files

app/[locale]/[...slug]/page.tsx

@@ -0,0 +1,109 @@
+import pick from "lodash.pick"
+import { notFound } from "next/navigation"
+import { getMessages, setRequestLocale } from "next-intl/server"
+
+import I18nProvider from "@/components/I18nProvider"
+import mdComponents from "@/components/MdComponents"
+
+import { dataLoader } from "@/lib/utils/data/dataLoader"
+import { getPostSlugs } from "@/lib/utils/md"
+import { getRequiredNamespacesForPage } from "@/lib/utils/translations"
+
+import { LOCALES_CODES } from "@/lib/constants"
+
+import { componentsMapping, layoutMapping } from "@/layouts"
+import { fetchGFIs } from "@/lib/api/fetchGFIs"
+import { getPageData } from "@/lib/md/data"
+import { getMdMetadata } from "@/lib/md/metadata"
+
+const loadData = dataLoader([["gfissues", fetchGFIs]])
+
+export default async function Page({
+  params,
+}: {
+  params: Promise<{ locale: string; slug: string[] }>
+}) {
+  const { locale, slug: slugArray } = await params
+
+  // Check if this specific path is in our valid paths
+  const validPaths = await generateStaticParams()
+  const isValidPath = validPaths.some(
+    (path) =>
+      path.locale === locale && path.slug.join("/") === slugArray.join("/")
+  )
+
+  if (!isValidPath) {
+    notFound()
+  }
+
+  // Enable static rendering
+  setRequestLocale(locale)
+
+  const [gfissues] = await loadData()
+
+  const slug = slugArray.join("/")
+
+  const {
+    content,
+    frontmatter,
+    tocItems,
+    lastEditLocaleTimestamp,
+    isTranslated,
+  } = await getPageData({
+    locale,
+    slug,
+    // TODO: Address component typing error here (flip `FC` types to prop object types)
+    // @ts-expect-error Incompatible component function signatures
+    components: { ...mdComponents, ...componentsMapping },
+    scope: {
+      gfissues,
+    },
+  })
+
+  // Determine the actual layout after we have the frontmatter
+  const layout = frontmatter.template || "static"
+  const Layout = layoutMapping[layout]
+
+  // Get i18n messages
+  const allMessages = await getMessages({ locale })
+  const requiredNamespaces = getRequiredNamespacesForPage(slug, layout)
+  const messages = pick(allMessages, requiredNamespaces)
+
+  return (
+    <I18nProvider locale={locale} messages={messages}>
+      <Layout
+        slug={slug}
+        frontmatter={frontmatter}
+        tocItems={tocItems}
+        lastEditLocaleTimestamp={lastEditLocaleTimestamp}
+        contentNotTranslated={!isTranslated}
+      >
+        {content}
+      </Layout>
+    </I18nProvider>
+  )
+}
+
+export async function generateStaticParams() {
+  const slugs = await getPostSlugs("/", /\/developers/)
+
+  return LOCALES_CODES.flatMap((locale) =>
+    slugs.map((slug) => ({
+      slug: slug.split("/").slice(1),
+      locale,
+    }))
+  )
+}
+
+export async function generateMetadata({
+  params,
+}: {
+  params: Promise<{ locale: string; slug: string[] }>
+}) {
+  const { locale, slug } = await params
+
+  return await getMdMetadata({
+    locale,
+    slug,
+  })
+}

app/[locale]/developers/docs/[[...doc]]/page.tsx

@@ -0,0 +1,98 @@
+import { join } from "path"
+
+import pick from "lodash.pick"
+import { getMessages, setRequestLocale } from "next-intl/server"
+
+import I18nProvider from "@/components/I18nProvider"
+import mdComponents from "@/components/MdComponents"
+
+import { getPostSlugs } from "@/lib/utils/md"
+import { getRequiredNamespacesForPage } from "@/lib/utils/translations"
+
+import { LOCALES_CODES } from "@/lib/constants"
+
+import { docsComponents, DocsLayout } from "@/layouts"
+import { getPageData } from "@/lib/md/data"
+import { getMdMetadata } from "@/lib/md/metadata"
+
+export default async function Page({
+  params,
+}: {
+  params: Promise<{ locale: string; doc?: string[] }>
+}) {
+  const { locale, doc: docArray } = await params
+
+  // Enable static rendering
+  setRequestLocale(locale)
+
+  const slug = join("developers/docs", ...(docArray || []))
+
+  const layout = "docs"
+
+  const {
+    content,
+    frontmatter,
+    tocItems,
+    lastEditLocaleTimestamp,
+    contributors,
+    isTranslated,
+  } = await getPageData({
+    locale,
+    slug,
+    // TODO: Address component typing error here (flip `FC` types to prop object types)
+    // @ts-expect-error Incompatible component function signatures
+    components: { ...mdComponents, ...docsComponents },
+    layout,
+  })
+
+  // Get i18n messages
+  const allMessages = await getMessages({ locale })
+  const requiredNamespaces = getRequiredNamespacesForPage(slug, layout)
+  const messages = pick(allMessages, requiredNamespaces)
+
+  return (
+    <I18nProvider locale={locale} messages={messages}>
+      <DocsLayout
+        slug={slug}
+        frontmatter={frontmatter}
+        tocItems={tocItems}
+        lastEditLocaleTimestamp={lastEditLocaleTimestamp}
+        contributors={contributors}
+        contentNotTranslated={!isTranslated}
+      >
+        {content}
+      </DocsLayout>
+    </I18nProvider>
+  )
+}
+
+export async function generateStaticParams() {
+  const slugs = await getPostSlugs("/developers/docs")
+
+  // Generate page paths for each supported locale
+  return LOCALES_CODES.flatMap((locale) =>
+    slugs.map((slug) => {
+      return {
+        // Splitting nested paths to generate proper slug
+        doc: slug.replace("/developers/docs", "").split("/").slice(1),
+        locale,
+      }
+    })
+  )
+}
+
+export async function generateMetadata({
+  params,
+}: {
+  params: Promise<{ locale: string; doc: string[] }>
+}) {
+  const { locale, doc } = await params
+  const slug = ["developers/docs", ...(doc || [])]
+
+  return await getMdMetadata({
+    locale,
+    slug,
+  })
+}
+
+export const dynamicParams = false