fix: solved conflicts and reviewed content

Author: FelixNicolaeBucsa

.env.example

@@ -0,0 +1,6 @@
+BACKEND_URL=
+NEXT_PUBLIC_GOOGLE_ANALYTICS_TRACKING_ID=
+NEXT_PUBLIC_ALGOLIA_APP_ID=
+NEXT_PUBLIC_ALGOLIA_API_KEY=
+NEXT_PUBLIC_ALGOLIA_INDEX=
+NEWSLETTER_BASE_URL=

.env.local

@@ -39,6 +39,11 @@ jobs:
         env:
           BACKEND_URL: ${{ secrets.NEXT_PUBLIC_BACKEND_URL }}
           NEXT_PUBLIC_GOOGLE_ANALYTICS_TRACKING_ID: ${{ secrets.NEXT_PUBLIC_GOOGLE_ANALYTICS_TRACKING_ID }}
+          NEXT_PUBLIC_ALGOLIA_APP_ID: ${{ secrets.NEXT_PUBLIC_ALGOLIA_APP_ID }}
+          NEXT_PUBLIC_ALGOLIA_API_KEY: ${{ secrets.NEXT_PUBLIC_ALGOLIA_API_KEY }}
+          NEXT_PUBLIC_ALGOLIA_INDEX: ${{ secrets.NEXT_PUBLIC_ALGOLIA_INDEX }}
+          NEWSLETTER_BASE_URL: ${{ secrets.NEWSLETTER_BASE_URL }}
+          SENDER_TOKEN: ${{ secrets.SENDER_TOKEN }}
 
       - name: Trigger Image Update
         run: |

.github/workflows/deploy-production.yml

@@ -39,6 +39,11 @@ jobs:
         env:
           BACKEND_URL: ${{ secrets.STAGING_NEXT_PUBLIC_BACKEND_URL }}
           NEXT_PUBLIC_GOOGLE_ANALYTICS_TRACKING_ID: ${{ secrets.NEXT_PUBLIC_GOOGLE_ANALYTICS_TRACKING_ID }}
+          NEXT_PUBLIC_ALGOLIA_APP_ID: ${{ secrets.NEXT_PUBLIC_ALGOLIA_APP_ID }}
+          NEXT_PUBLIC_ALGOLIA_API_KEY: ${{ secrets.NEXT_PUBLIC_ALGOLIA_API_KEY }}
+          NEXT_PUBLIC_ALGOLIA_INDEX: ${{ secrets.NEXT_PUBLIC_ALGOLIA_INDEX }}
+          NEWSLETTER_BASE_URL: ${{ secrets.NEWSLETTER_BASE_URL }}
+          SENDER_TOKEN: ${{ secrets.SENDER_TOKEN }}
 
   deploy:
     name: Deployment

.github/workflows/deploy-staging.yml

@@ -40,6 +40,11 @@ jobs:
         env:
           BACKEND_URL: ${{ secrets.STAGING_NEXT_PUBLIC_BACKEND_URL }}
           NEXT_PUBLIC_GOOGLE_ANALYTICS_TRACKING_ID: ${{ secrets.NEXT_PUBLIC_GOOGLE_ANALYTICS_TRACKING_ID }}
+          NEXT_PUBLIC_ALGOLIA_APP_ID: ${{ secrets.NEXT_PUBLIC_ALGOLIA_APP_ID }}
+          NEXT_PUBLIC_ALGOLIA_API_KEY: ${{ secrets.NEXT_PUBLIC_ALGOLIA_API_KEY }}
+          NEXT_PUBLIC_ALGOLIA_INDEX: ${{ secrets.NEXT_PUBLIC_ALGOLIA_INDEX }}
+          NEWSLETTER_BASE_URL: ${{ secrets.NEWSLETTER_BASE_URL }}
+          SENDER_TOKEN: ${{ secrets.SENDER_TOKEN }}
 
   deploy:
     name: Ephermeral Deployment

.github/workflows/ephemeral-deploy.yaml

@@ -1,6 +1,12 @@
 FROM node:18-alpine
 
 ARG BACKEND_URL=""
+ARG NEXT_PUBLIC_GOOGLE_ANALYTICS_TRACKING_ID=""
+ARG NEXT_PUBLIC_ALGOLIA_APP_ID=""
+ARG NEXT_PUBLIC_ALGOLIA_API_KEY=""
+ARG NEXT_PUBLIC_ALGOLIA_INDEX=""
+ARG NEWSLETTER_BASE_URL=""
+ARG SENDER_TOKEN=""
 
 RUN apk add tree && corepack prepare [email protected] --activate && corepack enable
 
@@ -14,7 +20,12 @@ COPY . /app
 ENV NODE_ENV="production"
 
 RUN echo BACKEND_URL="${BACKEND_URL}" > .env.local && \
+    echo SENDER_TOKEN="${SENDER_TOKEN}" > .env.local && \
     echo NEXT_PUBLIC_GOOGLE_ANALYTICS_TRACKING_ID="${NEXT_PUBLIC_GOOGLE_ANALYTICS_TRACKING_ID}" >> .env.local && \
+    echo NEXT_PUBLIC_ALGOLIA_APP_ID="${NEXT_PUBLIC_ALGOLIA_APP_ID}" >> .env.local && \
+    echo NEXT_PUBLIC_ALGOLIA_API_KEY="${NEXT_PUBLIC_ALGOLIA_API_KEY}" >> .env.local && \
+    echo NEXT_PUBLIC_ALGOLIA_INDEX="${NEXT_PUBLIC_ALGOLIA_INDEX}" >> .env.local && \
+    echo NEWSLETTER_BASE_URL="${NEWSLETTER_BASE_URL}" >> .env.local && \
     pnpm build
 
 ENTRYPOINT ["pnpm"]

Dockerfile

@@ -15,12 +15,6 @@ Select the appropriate route, and create a new file ending in `.mdx`. Then, upda
 }
 ```
 
-## Deployments
-
-### Staging Website
-
-https://docs-staging.sandbox-london-b.fetch-ai.com/docs
-
 ## Developing
 
 ### Install dependencies

README.md

@@ -9,10 +9,8 @@ import {
   Tab,
   DropDownTabs,
 } from "./mdx";
-import { useUserContext } from "theme/fetch-ai-docs/contexts/context-provider";
 import Tooltip from "./tooltip";
 import Link from "next/link";
-import fetchJson from "src/lib/fetch-json";
 
 interface PropertyType {
   name: string;
@@ -347,29 +345,27 @@ export const ApiEndpointRequestResponse: React.FC<{
     setIsModalOpen(false);
   };
 
-  const context = useUserContext();
-
-  const hitRequest = async () => {
+  const hitRequestWithoutLogin = async () => {
     try {
       setLoading(true);
       setError("");
       const requestPayloadJSON = JSON.parse(requestPayload || "{}");
       const apiUrlWithParams = (properties.apiUrl +
         replacePathParameters(properties.path, pathParameters)) as string;
-
-      const response: { data: unknown } = await fetchJson(
-        `/docs/api/api-requests?url=${apiUrlWithParams}`,
-        {
-          method: properties.method,
-          body: properties.method.includes("GET") ? null : requestPayloadJSON,
+      const response = await fetch(apiUrlWithParams, {
+        method: properties.method,
+        headers: {
+          "Content-Type": "application/json",
+          Authorization: `Bearer ${bearerToken}`,
         },
-      );
-      const responseText = JSON.stringify(response.data, null, 2);
+        body: properties.method.includes("GET")
+          ? null
+          : JSON.stringify(requestPayloadJSON),
+      });
+      const data = await response.json();
+      const responseText = JSON.stringify(data, null, 2);
       setActualResponse(responseText);
     } catch (error) {
-      if (error.response.status === 422) {
-        context.signOut();
-      }
       setError(`Error: ${error.message}`);
     } finally {
       setLoading(false);
@@ -420,7 +416,7 @@ export const ApiEndpointRequestResponse: React.FC<{
               </div>
             </div>
             <div className="nx-mt-2 nx-mb-4 nx-border-t nx-border-gray-300" />
-            {!context?.isLoggedIn && isBearerTokenRequired && (
+            {isBearerTokenRequired && (
               <div className="md:nx-flex nx-block nx-items-center nx-ml-4">
                 <div className="nx-flex nx-gap-2 nx-w-1/4">
                   <p className="nextra-content nx-text-sm">
@@ -530,7 +526,7 @@ export const ApiEndpointRequestResponse: React.FC<{
               <div className="nx-w-1/4">
                 <button
                   className="nx-bg-purple hover:nx-bg-purple-500 nx-text-white nx-py-2 nx-px-4 nx-rounded-xxl nx-text-sm nx-mt-6"
-                  onClick={hitRequest}
+                  onClick={hitRequestWithoutLogin}
                 >
                   Execute
                 </button>

components/account-menu.tsx

@@ -45,19 +45,19 @@ export const FeatureGuideTabs = ({ centerMode }: { centerMode?: boolean }) => {
       label: "Agents",
       content: [
         {
-          title: "Installing the uAgents Framework 🛠️📲",
+          title: "Installing the uAgents Framework",
           description:
             "A guide for installing the uAgents Framework correctly.",
           path: "guides/agents/installing-uagent",
         },
         {
-          title: "Creating your first agent 🤖🧑‍💻",
+          title: "Creating your first agent",
           description:
             "A guide showing how to create your first agent in few minutes.",
           path: "guides/agents/create-a-uagent",
         },
         {
-          title: "How to use agents to verify messages 📬🔐",
+          title: "How to use agents to verify messages",
           description: "A guide showing how to use agents to verify messages.",
           path: "guides/agents/message-verification",
         },
@@ -68,13 +68,13 @@ export const FeatureGuideTabs = ({ centerMode }: { centerMode?: boolean }) => {
           path: "guides/agents/register-in-almanac",
         },
         {
-          title: "Communicating with other agents 📱🤖",
+          title: "Communicating with other agents",
           description:
             "A guide showing different communication methods between agents.",
           path: "guides/agents/communicating-with-other-agents",
         },
         {
-          title: "Agent address 🤖📫",
+          title: "Agent address",
           description: "A guide showing how to retrieve agents addresses.",
           path: "guides/agents/getting-uagent-address",
         },
@@ -84,13 +84,13 @@ export const FeatureGuideTabs = ({ centerMode }: { centerMode?: boolean }) => {
       label: "Agentverse",
       content: [
         {
-          title: "Creating an Agentverse hosted agent 🤖",
+          title: "Creating an Agentverse hosted agent",
           description:
             "Use the Agentverse: My Agents tab to develop agents directly on the Agentverse platform.",
           path: "/guides/agentverse/creating-a-hosted-agent",
         },
         {
-          title: "Utilizing the Agentverse Mailroom service 📬",
+          title: "Utilizing the Agentverse Mailroom service",
           description:
             "Set up Agentverse mailboxes for your locally-run agents and to run them independently of your constant presence to run the server.",
           path: "/guides/agentverse/utilising-the-mailbox",
@@ -104,7 +104,7 @@ export const FeatureGuideTabs = ({ centerMode }: { centerMode?: boolean }) => {
         },
         {
           title:
-            "Agentverse Functions: register a coin toss agent as a Function 🪙",
+            "Agentverse Functions: register a coin toss agent as a Function",
           description:
             "Create and make an coin toss Function discoverable on the Agentverse and DeltaV!",
           path: "/guides/agentverse/registering-agent-coin-toss",
@@ -121,19 +121,19 @@ export const FeatureGuideTabs = ({ centerMode }: { centerMode?: boolean }) => {
       label: "Other",
       content: [
         {
-          title: "Fetch Wallet 💵",
+          title: "Fetch Wallet",
           description:
             "A guide helping you to get started with the Fetch wallet.",
           path: "/guides/fetch-network/fetch-wallet/fetch-wallet-getting-started",
         },
         {
-          title: "How to convert FET to and from ERC20 🔄",
+          title: "How to convert FET to and from ERC20",
           description:
             "A guide for converting Native FET to and from ERC-20 FET.",
           path: "/guides/fetch-network/how-to-convert-fet-to-and-from-erc20",
         },
         {
-          title: "How to get testnet tokens via the Token Faucet 💰",
+          title: "How to get testnet tokens via the Token Faucet",
           description:
             "Learn how to get testnet tokens using the Faucet service.",
           path: "/guides/fetch-network/ledger/faucet",

components/api-endpoint.tsx

@@ -68,7 +68,16 @@ const Footer: React.FC = () => {
 
   const [email, setEmail] = useState<string>("");
   const [message, setMessage] = useState<string>("");
+
   const onClick = async () => {
+    if (email === "") {
+      setMessage("Please enter your email address.");
+      return;
+    } else if (!regex.test(email)) {
+      setMessage("Please enter a valid email address.");
+      return;
+    }
+
     const option = {
       method: "POST",
       headers: {
@@ -78,6 +87,7 @@ const Footer: React.FC = () => {
     };
     await fetch("/docs/api/newsletter", option);
   };
+
   const regex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
   const handleBlur = () => {
     if (email === "") {
@@ -87,6 +97,9 @@ const Footer: React.FC = () => {
     } else {
       setMessage("Please enter a valid email address.");
     }
+    setTimeout(() => {
+      setMessage("");
+    }, 5000);
   };
 
   return (
@@ -195,7 +208,7 @@ const Footer: React.FC = () => {
             <div className={styles.footerInputWrapper}>
               <div className={styles.footerInput}>
                 <span className={styles.footerText}>
-                  Sign up to for developer updates
+                  Sign up for developer updates
                 </span>
                 <div className={styles.inputBox}>
                   <input

components/feature-guide-tabs.tsx

@@ -15,17 +15,17 @@ function LandingPage() {
   const startingGuides = [
     {
       label: "Building your first agent",
-      path: "/guides/agents/installing-uagent",
+      path: "/guides/agents/quickstart",
       image: buildYourAgent,
     },
     {
       label: "Creating an executable function for AI",
-      path: "guides/agents/communicating-with-other-agents",
+      path: "/guides/agents/intermediate/agent-functions",
       image: executable,
     },
     {
       label: "The Fetch.ai technology stack",
-      path: "/guides/agentverse/creating-a-hosted-agent",
+      path: "/concepts/introducing-fetchai",
       image: techStack,
     },
   ];