refactor: update Docusaurus configuration and enhance documentation structure (#2029)

- Refactored docusaurus.config.ts to streamline configuration, including the addition of an API sidebar and improved edit URLs for documentation.
- Updated sidebars.ts to include a new autogenerated sidebar for the API documentation.
- Adjusted styles in styles.module.css for better feature display on the homepage.
- Modified logo.svg to use a viewBox for improved scalability.

These changes aim to enhance the organization and accessibility of the documentation, ensuring a better user experience.

docs/docusaurus.config.ts

@@ -9,29 +9,19 @@ const config: Config = {
   tagline: 'Modern Laravel-based BitTorrent tracker',
   favicon: 'img/favicon.ico',
 
-  // Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
   future: {
-    v4: true, // Improve compatibility with the upcoming Docusaurus v4
+    v4: true,
   },
 
-  // Set the production url of your site here
   url: 'https://docs.torrentpier.com',
-  // Set the /<baseUrl>/ pathname under which your site is served
-  // For GitHub pages deployment, it is often '/<projectName>/'
   baseUrl: '/',
-
+  organizationName: 'torrentpier',
-  // GitHub pages deployment config.
+  projectName: 'torrentpier.github.io',
-  // If you aren't using GitHub pages, you don't need these.
-  organizationName: 'torrentpier', // Usually your GitHub org/user name.
-  projectName: 'torrentpier.github.io', // Usually your repo name.
   trailingSlash: false,
 
   onBrokenLinks: 'throw',
   onBrokenMarkdownLinks: 'warn',
 
-  // Even if you don't use internationalization, you can use this field to set
-  // useful metadata like html lang. For example, if your site is Chinese, you
-  // may want to replace "en" with "zh-Hans".
   i18n: {
     defaultLocale: 'en',
     locales: ['en'],
@@ -43,10 +33,8 @@ const config: Config = {
       {
         docs: {
           sidebarPath: './sidebars.ts',
-          // Please change this to your repo.
+          editUrl: 'https://github.com/torrentpier/torrentpier/tree/dexter/docs/',
-          // Remove this to remove the "edit this page" links.
+          exclude: ['api/**'], // Exclude API folder from main docs
-          editUrl:
-            'https://github.com/torrentpier/torrentpier/tree/dexter/docs/',
         },
         blog: {
           showReadingTime: true,
@@ -54,11 +42,7 @@ const config: Config = {
             type: ['rss', 'atom'],
             xslt: true,
           },
-          // Please change this to your repo.
+          editUrl: 'https://github.com/torrentpier/torrentpier/tree/dexter/docs/',
-          // Remove this to remove the "edit this page" links.
-          editUrl:
-            'https://github.com/torrentpier/torrentpier/tree/dexter/docs/',
-          // Useful options to enforce blogging best practices
           onInlineTags: 'warn',
           onInlineAuthors: 'warn',
           onUntruncatedBlogPosts: 'warn',
@@ -70,8 +54,20 @@ const config: Config = {
     ],
   ],
 
+  plugins: [
+    [
+      '@docusaurus/plugin-content-docs',
+      {
+        id: 'api',
+        path: 'docs/api',
+        routeBasePath: 'api',
+        sidebarPath: './sidebars.ts',
+        editUrl: 'https://github.com/torrentpier/torrentpier/tree/dexter/docs/',
+      },
+    ],
+  ],
+
   themeConfig: {
-    // Replace with your project's social card
     image: 'img/social-card.jpg',
     navbar: {
       title: 'TorrentPier',
@@ -81,17 +77,19 @@ const config: Config = {
       },
       items: [
         {to: '/blog/welcome', label: 'Blog', position: 'left'},
-        {
-          to: '/docs/api/overview',
-          label: 'API',
-          position: 'left',
-        },
         {
           type: 'docSidebar',
           sidebarId: 'docsSidebar',
           position: 'left',
           label: 'Documentation',
         },
+        {
+          type: 'docSidebar',
+          sidebarId: 'apiSidebar',
+          docsPluginId: 'api',
+          position: 'left',
+          label: 'API',
+        },
         {
           href: 'https://github.com/torrentpier/torrentpier',
           label: 'GitHub',
@@ -109,6 +107,10 @@ const config: Config = {
               label: 'Getting Started',
               to: '/docs/intro',
             },
+            {
+              label: 'API Reference',
+              to: '/api/overview',
+            },
           ],
         },
         {

docs/sidebars.ts

@@ -15,19 +15,7 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
 const sidebars: SidebarsConfig = {
   // By default, Docusaurus generates a sidebar from the docs folder structure
   docsSidebar: [{type: 'autogenerated', dirName: '.'}],
-
+  apiSidebar: [{type: 'autogenerated', dirName: '.'}],
-  // But you can create a sidebar manually
-  /*
-  tutorialSidebar: [
-    'intro',
-    'hello',
-    {
-      type: 'category',
-      label: 'Tutorial',
-      items: ['tutorial-basics/create-a-document'],
-    },
-  ],
-   */
 };
 
 export default sidebars;

docs/src/components/HomepageFeatures/styles.module.css

@@ -6,6 +6,9 @@
 }
 
 .featureSvg {
-  height: 200px;
+  height: 140px;
-  width: 200px;
+  width: auto;
+  max-width: 100%;
+  display: block;
+  margin: 0 auto 1rem;
 }

docs/static/img/logo.svg

@@ -1,4 +1,4 @@
-<svg width="603" height="685" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
+<svg viewBox="0 0 603 685" width="603" height="685" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
     <defs>
         <linearGradient x1="3.311%" y1="3.278%" x2="96.35%" y2="95.406%" id="b">
             <stop stop-color="#90F1FF" offset="0%"/>