Merge branch 'dev' into e2e-tests

Author: pettinarip

.husky/pre-commit

@@ -1 +1 @@
-npx lint-staged
+npx lint-staged

app/[locale]/developers/tutorials/_components/modal.tsx

@@ -0,0 +1,76 @@
+"use client"
+
+import React, { useState } from "react"
+import { FaGithub } from "react-icons/fa"
+
+import Translation from "@/components/Translation"
+import { Button } from "@/components/ui/buttons/Button"
+import { ButtonLink } from "@/components/ui/buttons/Button"
+import Modal from "@/components/ui/dialog-modal"
+import { Flex } from "@/components/ui/flex"
+
+import { trackCustomEvent } from "@/lib/utils/matomo"
+
+import { useBreakpointValue } from "@/hooks/useBreakpointValue"
+
+const TutorialSubmitModal = ({
+  dir,
+}: Pick<React.HTMLAttributes<React.JSX.Element>, "dir">) => {
+  const [isModalOpen, setModalOpen] = useState(false)
+
+  const modalSize = useBreakpointValue({ base: "xl", md: "md" } as const)
+
+  return (
+    <>
+      <Modal
+        open={isModalOpen}
+        onOpenChange={(open) => setModalOpen(open)}
+        size={modalSize}
+        contentProps={{ dir }}
+        title={
+          <Translation id="page-developers-tutorials:page-tutorial-submit-btn" />
+        }
+      >
+        <p className="mb-6">
+          <Translation id="page-developers-tutorials:page-tutorial-listing-policy-intro" />
+        </p>
+        <Flex className="flex-col gap-2 md:flex-row">
+          <Flex className="w-full flex-col justify-between rounded-sm border border-border p-4">
+            <b>
+              <Translation id="page-developers-tutorials:page-tutorial-create-an-issue" />
+            </b>
+            <p className="mb-6">
+              <Translation id="page-developers-tutorials:page-tutorial-create-an-issue-desc" />
+            </p>
+            <ButtonLink
+              variant="outline"
+              href="https://github.com/ethereum/ethereum-org-website/issues/new?assignees=&labels=Type%3A+Feature&template=suggest_tutorial.yaml&title="
+            >
+              <FaGithub />
+              <Translation id="page-developers-tutorials:page-tutorial-raise-issue-btn" />
+            </ButtonLink>
+          </Flex>
+        </Flex>
+      </Modal>
+
+      <Button
+        className="px-3 py-2 text-body"
+        variant="outline"
+        onClick={() => {
+          setModalOpen(true)
+          trackCustomEvent({
+            eventCategory: "tutorials tags",
+            eventAction: "click",
+            eventName: "submit",
+          })
+        }}
+      >
+        <Translation id="page-developers-tutorials:page-tutorial-submit-btn" />
+      </Button>
+    </>
+  )
+}
+
+TutorialSubmitModal.displayName = "TutorialSubmitModal"
+
+export default TutorialSubmitModal

app/[locale]/developers/tutorials/_components/tutorials.tsx

@@ -9,18 +9,14 @@ import React, {
   useState,
 } from "react"
 import { useLocale } from "next-intl"
-import { FaGithub } from "react-icons/fa"
 
 import { ITutorial, Lang } from "@/lib/types"
 
 import Emoji from "@/components/Emoji"
-import FeedbackCard from "@/components/FeedbackCard"
-import MainArticle from "@/components/MainArticle"
 import Translation from "@/components/Translation"
 import { getSkillTranslationId } from "@/components/TutorialMetadata"
 import TutorialTags from "@/components/TutorialTags"
-import { Button, ButtonLink } from "@/components/ui/buttons/Button"
-import Modal from "@/components/ui/dialog-modal"
+import { Button } from "@/components/ui/buttons/Button"
 import { Flex, FlexProps } from "@/components/ui/flex"
 import { Tag, TagButton } from "@/components/ui/tag"
 
@@ -36,12 +32,6 @@ import externalTutorials from "@/data/externalTutorials.json"
 
 import { DEFAULT_LOCALE } from "@/lib/constants"
 
-import { useBreakpointValue } from "@/hooks/useBreakpointValue"
-
-type LinkFlexProps = FlexProps & {
-  href: string
-}
-
 const FilterTag = forwardRef<
   HTMLButtonElement,
   { isActive: boolean; name: string } & ButtonHTMLAttributes<HTMLButtonElement>
@@ -66,6 +56,10 @@ const Text = ({ className, ...props }: HTMLAttributes<HTMLHeadElement>) => (
   <p className={cn("mb-6", className)} {...props} />
 )
 
+type LinkFlexProps = FlexProps & {
+  href: string
+}
+
 const LinkFlex = ({ href, children, ...props }: LinkFlexProps) => {
   return (
     <Flex asChild {...props}>
@@ -85,15 +79,11 @@ const published = (locale: string, published: string) => {
   ) : null
 }
 
-type TutorialPageProps = {
+type TutorialsListProps = {
   internalTutorials: ITutorial[]
-  contentNotTranslated: boolean
 }
 
-const TutorialPage = ({
-  internalTutorials,
-  contentNotTranslated,
-}: TutorialPageProps) => {
+const TutorialsList = ({ internalTutorials }: TutorialsListProps) => {
   const locale = useLocale()
   const effectiveLocale = internalTutorials.length > 0 ? locale : DEFAULT_LOCALE
   const filteredTutorialsByLang = useMemo(
@@ -111,7 +101,6 @@ const TutorialPage = ({
     [filteredTutorialsByLang]
   )
 
-  const [isModalOpen, setModalOpen] = useState(false)
   const [filteredTutorials, setFilteredTutorials] = useState(
     filteredTutorialsByLang
   )
@@ -152,66 +141,8 @@ const TutorialPage = ({
     setSelectedTags([...tempSelectedTags])
   }
 
-  const dir = contentNotTranslated ? "ltr" : "unset"
-
-  const modalSize = useBreakpointValue({ base: "xl", md: "md" } as const)
   return (
-    <MainArticle
-      className={`mx-auto my-0 mt-16 flex w-full flex-col items-center ${dir}`}
-    >
-      <h1 className="no-italic mb-4 text-center font-monospace text-[2rem] font-semibold uppercase leading-[1.4] max-sm:mx-4 max-sm:mt-4 sm:mb-[1.625rem]">
-        <Translation id="page-developers-tutorials:page-tutorial-title" />
-      </h1>
-      <Text className="mb-4 text-center leading-xs text-body-medium">
-        <Translation id="page-developers-tutorials:page-tutorial-subtitle" />
-      </Text>
-
-      <Modal
-        open={isModalOpen}
-        onOpenChange={(open) => setModalOpen(open)}
-        size={modalSize}
-        contentProps={{ dir }}
-        title={
-          <Translation id="page-developers-tutorials:page-tutorial-submit-btn" />
-        }
-      >
-        <Text>
-          <Translation id="page-developers-tutorials:page-tutorial-listing-policy-intro" />
-        </Text>
-        <Flex className="flex-col gap-2 md:flex-row">
-          <Flex className="w-full flex-col justify-between rounded-sm border border-border p-4">
-            <b>
-              <Translation id="page-developers-tutorials:page-tutorial-create-an-issue" />
-            </b>
-            <Text>
-              <Translation id="page-developers-tutorials:page-tutorial-create-an-issue-desc" />
-            </Text>
-            <ButtonLink
-              variant="outline"
-              href="https://github.com/ethereum/ethereum-org-website/issues/new?assignees=&labels=Type%3A+Feature&template=suggest_tutorial.yaml&title="
-            >
-              <FaGithub />
-              <Translation id="page-developers-tutorials:page-tutorial-raise-issue-btn" />
-            </ButtonLink>
-          </Flex>
-        </Flex>
-      </Modal>
-
-      <Button
-        className="px-3 py-2 text-body"
-        variant="outline"
-        onClick={() => {
-          setModalOpen(true)
-          trackCustomEvent({
-            eventCategory: "tutorials tags",
-            eventAction: "click",
-            eventName: "submit",
-          })
-        }}
-      >
-        <Translation id="page-developers-tutorials:page-tutorial-submit-btn" />
-      </Button>
-
+    <>
       <div className="my-8 w-full shadow-table-box md:w-2/3">
         <Flex className="m-8 flex-col justify-center border-b border-border px-0 pb-4 pt-4 md:pb-8">
           <Flex className="mb-4 max-w-full flex-wrap items-center gap-2">
@@ -312,9 +243,8 @@ const TutorialPage = ({
           )
         })}
       </div>
-      <FeedbackCard />
-    </MainArticle>
+    </>
   )
 }
 
-export default TutorialPage
+export default TutorialsList

app/[locale]/developers/tutorials/page.tsx

@@ -1,4 +1,5 @@
 import { pick } from "lodash"
+import dynamic from "next/dynamic"
 import {
   getMessages,
   getTranslations,
@@ -7,20 +8,51 @@ import {
 
 import { Lang } from "@/lib/types"
 
+import FeedbackCard from "@/components/FeedbackCard"
 import I18nProvider from "@/components/I18nProvider"
+import MainArticle from "@/components/MainArticle"
+import { Skeleton, SkeletonCardContent } from "@/components/ui/skeleton"
 
 import { existsNamespace } from "@/lib/utils/existsNamespace"
 import { getTutorialsData } from "@/lib/utils/md"
 import { getMetadata } from "@/lib/utils/metadata"
 import { getRequiredNamespacesForPage } from "@/lib/utils/translations"
 
-import Tutorials from "./_components/tutorials"
+const TutorialsList = dynamic(() => import("./_components/tutorials"), {
+  ssr: false,
+  loading: () => (
+    <div className="mt-8 w-full md:w-2/3">
+      <div className="grid w-full grid-cols-3 gap-2 px-8 pb-16 pt-12 sm:grid-cols-4 lg:gap-4 2xl:grid-cols-5">
+        {Array.from({ length: 30 }).map((_, index) => (
+          <Skeleton key={"tag" + index} className="h-8 rounded-full" />
+        ))}
+      </div>
+      {Array.from({ length: 5 }).map((_, index) => (
+        <SkeletonCardContent key={"card" + index} className="p-8" />
+      ))}
+    </div>
+  ),
+})
+
+const TutorialSubmitModal = dynamic(() => import("./_components/modal"), {
+  ssr: false,
+  loading: () => (
+    <div className="w-full max-w-40 rounded border p-3">
+      <Skeleton className="h-5 w-full" />
+    </div>
+  ),
+})
 
 const Page = async ({ params }: { params: Promise<{ locale: Lang }> }) => {
   const { locale } = await params
 
   setRequestLocale(locale)
 
+  const t = await getTranslations({
+    locale,
+    namespace: "page-developers-tutorials",
+  })
+
   // Get i18n messages
   const allMessages = await getMessages({ locale })
   const requiredNamespaces = getRequiredNamespacesForPage(
@@ -29,13 +61,29 @@ const Page = async ({ params }: { params: Promise<{ locale: Lang }> }) => {
   const messages = pick(allMessages, requiredNamespaces)
 
   const contentNotTranslated = !existsNamespace(locale!, requiredNamespaces[2])
+  const dir = contentNotTranslated ? "ltr" : "unset"
+
+  const internalTutorials = await getTutorialsData(locale)
 
   return (
     <I18nProvider locale={locale} messages={messages}>
-      <Tutorials
-        internalTutorials={getTutorialsData(locale)}
-        contentNotTranslated={contentNotTranslated}
-      />
+      <MainArticle
+        className="mx-auto my-0 mt-16 flex w-full flex-col items-center"
+        dir={dir}
+      >
+        <h1 className="no-italic mb-4 text-center font-monospace text-[2rem] font-semibold uppercase leading-[1.4] max-sm:mx-4 max-sm:mt-4 sm:mb-[1.625rem]">
+          {t("page-tutorial-title")}
+        </h1>
+        <p className="mb-4 text-center leading-xs text-body-medium">
+          {t("page-tutorial-subtitle")}
+        </p>
+
+        <TutorialSubmitModal dir={dir} />
+
+        <TutorialsList internalTutorials={internalTutorials} />
+
+        <FeedbackCard />
+      </MainArticle>
     </I18nProvider>
   )
 }

docs/review-process.md

@@ -50,4 +50,6 @@ Adding new products is currently a low-to-medium priority (depending on the type
 
 Adding new tutorials to [ethereum.org](http://ethereum.org) is currently low-priority. We are currently in the middle of an epic to revamp our tutorials. As part of this, we’ll be reviewing our existing tutorials, purging outdated or low-quality tutorials, and refining our listing criteria for future tutorials to meet our increased standards. Please always create an issue to discuss the usefulness of your proposed tutorial before opening a PR.
 
+New tutorials should be placed in `public/content/developers/tutorials/your-tutorial-name/index.md`, with `your-tutorial-name` added to `src/data/internalTutorials.json` for inclusion.
+
 **Timeline:** PRs should be closed or merged within 30 days of opening.

package.json

@@ -22,6 +22,7 @@
     "markdown-checker": "ts-node -O '{ \"module\": \"commonjs\" }' src/scripts/markdownChecker.ts",
     "events-import": "ts-node -O '{ \"module\": \"commonjs\" }' src/scripts/events-import.ts",
     "crowdin-needs-review": "ts-node -O '{ \"module\": \"commonjs\" }' src/scripts/crowdin/reports/generateReviewReport.ts",
+    "update-tutorials": "ts-node -O '{ \"module\": \"commonjs\" }' src/scripts/update-tutorials-list.ts",
     "prepare": "husky",
     "test:e2e": "playwright test",
     "test:e2e:ui": "playwright test --ui",
@@ -157,5 +158,5 @@
     "unist-util-visit": "^5.0.0",
     "xml2js": "^0.6.2"
   },
-  "packageManager": "[email protected].3+sha512.467df2c586056165580ad6dfb54ceaad94c5a30f80893ebdec5a44c5aa73c205ae4a5bb9d5ed6bb84ea7c249ece786642bbb49d06a307df218d03da41c317417"
+  "packageManager": "[email protected].4"
 }

src/components/Nav/Client/index.tsx

@@ -11,13 +11,14 @@ import { Skeleton } from "@/components/ui/skeleton"
 
 import { DESKTOP_LANGUAGE_BUTTON_NAME } from "@/lib/constants"
 
+import { Button } from "../../ui/buttons/Button"
 import { useNavigation } from "../useNavigation"
 import { useThemeToggle } from "../useThemeToggle"
 
 import { useBreakpointValue } from "@/hooks/useBreakpointValue"
 import { useTranslation } from "@/hooks/useTranslation"
 
-const Button = dynamic(
+const LazyButton = dynamic(
   () => import("../../ui/buttons/Button").then((mod) => mod.Button),
   {
     ssr: false,
@@ -127,15 +128,15 @@ const ClientSideNav = () => {
         </SearchProvider>
 
         {desktopScreen && (
-          <Button
+          <LazyButton
             aria-label={themeIconAriaLabel}
             variant="ghost"
             isSecondary
             className="group animate-fade-in px-2 max-md:hidden xl:px-3 [&>svg]:transition-transform [&>svg]:duration-500 [&>svg]:hover:rotate-12 [&>svg]:hover:text-primary-hover"
             onClick={toggleColorMode}
           >
             <ThemeIcon className="transform-transform duration-500 group-hover:rotate-12 group-hover:transition-transform group-hover:duration-500" />
-          </Button>
+          </LazyButton>
         )}
 
         {desktopScreen && (
@@ -157,6 +158,4 @@ const ClientSideNav = () => {
   )
 }
 
-ClientSideNav.displayName = "ClientSideNav"
-
 export default ClientSideNav