docs: add v8 release information page

onesoft-sudo · Jan 30, 2024 · e08af0a · e08af0a
1 parent eee3cb5
commit e08af0a
Show file tree

Hide file tree

Showing 5 changed files with 105 additions and 0 deletions.
diff --git a/docs/app/(docs)/whats-new-in-v8/page.mdx b/docs/app/(docs)/whats-new-in-v8/page.mdx
@@ -0,0 +1,49 @@
+---
+title: "What's new in v8.0? - SudoBot"
+short_name: "What's new in v8.0?"
+---
+
+import sudobot8 from '@/images/sudobot-v8.png';
+
+# Introducing SudoBot v8.0!
+
+<ImageWithSkeleton 
+    src={sudobot8.src} 
+    alt="SudoBot 8 Branding" 
+    width={sudobot8.width} 
+    height={sudobot8.height} 
+    blurDataURL={sudobot8.blurDataURL}
+    style={{ width: '100%' }}
+    placeholder="blur"
+/>
+
+Wishing a happy new year to everyone out there! We've released version 8.0 of SudoBot, as always, packed with a bunch of new features, fixes and improvements! If you have any questions or suggestions, feel free to let us know!
+
+## Changes
+
+### Features
+
+* Now Fully Supporting [Bun](https://bun.sh)! During performance tests, SudoBot's performance was 25% better when using Bun instead of Node.js
+* Authentication and Loading Environment Variables using a Credential Server
+* URL Filtering by Crawling **[Experimental]**
+* Embed Text Filter
+* Image Text Filtering
+
+### Improvements and Refactorings
+
+* Refactored all the decorators to support TypeScript 5 Decorators as well as the old experimental decorators, to support bun
+* Refactored the HTTP Server class
+
+### Fixes
+
+* Minor performance fixes
+
+## Updating
+
+To update your instance, simply download the [latest release](https://github.com/onesoft-sudo/sudobot/releases/latest), or run the `-update` command.
+You can also use [Git](https://git-scm.com) to update your instance, by running this command:
+
+```bash
+git pull origin main
+```
+However, this will update your instance to the latest **unstable** version.
diff --git a/docs/components/MDX/ImageWithSkeleton.tsx b/docs/components/MDX/ImageWithSkeleton.tsx
@@ -0,0 +1,30 @@
+"use client";
+
+import { ComponentProps, FC, useState } from "react";
+import Image from "next/image";
+import styles from "@/styles/ImageWithSkeleton.module.css";
+
+type ImageWithSkeletonProps = ComponentProps<typeof Image>;
+
+const ImageWithSkeleton: FC<ImageWithSkeletonProps> = ({ ...imageProps }) => {
+    const [isLoaded, setIsLoaded] = useState(false);
+    const { onLoad, ...finalImageProps } = imageProps;
+
+    return (
+        <div className="relative">
+            <Image
+                onLoad={() => {
+                    setIsLoaded(true);
+                }}
+                {...finalImageProps}
+            />
+            {!isLoaded && (
+                <div
+                    className={`absolute top-0 left-0 h-[100%] w-[100%] ${styles.skeleton}`}
+                ></div>
+            )}
+        </div>
+    );
+};
+
+export default ImageWithSkeleton;
diff --git a/docs/images/sudobot-v8.png b/docs/images/sudobot-v8.png
diff --git a/docs/mdx-components.tsx b/docs/mdx-components.tsx
@@ -1,7 +1,18 @@
+import { Skeleton } from "@mui/material";
 import type { MDXComponents } from "mdx/types";
+import Image from "next/image";
+import { ComponentProps } from "react";
+import ImageWithSkeleton from "./components/MDX/ImageWithSkeleton";
 
 export function useMDXComponents(components: MDXComponents): MDXComponents {
     return {
         ...components,
+        Image: (props: ComponentProps<typeof Image>) => <Image {...props} />,
+        ImageWithSkeleton: (
+            props: ComponentProps<typeof ImageWithSkeleton>,
+        ) => <ImageWithSkeleton {...props} />,
+        Skeleton: (props: ComponentProps<typeof Skeleton>) => (
+            <Skeleton {...props} />
+        ),
     };
 }
diff --git a/docs/styles/ImageWithSkeleton.module.css b/docs/styles/ImageWithSkeleton.module.css
@@ -0,0 +1,15 @@
+.skeleton {
+    animation: skeleton 2.5s linear infinite;
+    border-radius: 5px;
+}
+
+@keyframes skeleton {
+    100%,
+    0% {
+        background: #000;
+    }
+
+    50% {
+        background: #333;
+    }
+}