Update documentation structure and sync script; remove old guide index, adjust navigation links, and clean up .gitignore

Author: xentixar

.gitignore

@@ -2,6 +2,6 @@ node_modules
 .DS_Store
 dist
 .cache
-.vitepress/cache
-.vitepress/dist
-
+docs/.vitepress/cache
+docs/.vitepress/dist
+docs/**/*.md

docs/.vitepress/config.js

@@ -19,9 +19,8 @@ export default defineConfig({
 
     nav: [
       { text: 'Home', link: '/' },
-      { text: 'Guide', link: '/guide/' },
-      { text: 'Examples', link: '/examples/' },
-      { text: 'API', link: '/api/' },
+      { text: 'Guide', link: '/getting-started/installation' },
+      { text: 'Examples', link: '/examples/counter' },
       { 
         text: 'GitHub', 
         link: 'https://github.com/diffyne/diffyne',
@@ -30,65 +29,54 @@ export default defineConfig({
     ],
 
     sidebar: {
-      '/guide/': [
+      '/': [
         {
           text: 'Getting Started',
           items: [
-            { text: 'Introduction', link: '/guide/' },
-            { text: 'Installation', link: '/guide/installation' },
-            { text: 'Quick Start', link: '/guide/quickstart' },
-            { text: 'Your First Component', link: '/guide/first-component' }
+            { text: 'Installation', link: '/getting-started/installation' },
+            { text: 'Quick Start', link: '/getting-started/quickstart' },
+            { text: 'Your First Component', link: '/getting-started/first-component' }
           ]
         },
         {
-          text: 'Core Concepts',
+          text: 'Features',
           items: [
-            { text: 'Components', link: '/guide/components' },
-            { text: 'Properties & State', link: '/guide/properties' },
-            { text: 'Methods & Actions', link: '/guide/methods' },
-            { text: 'Lifecycle Hooks', link: '/guide/lifecycle' }
+            { text: 'Directives', link: '/features/directives' },
+            { text: 'Attributes', link: '/features/attributes' },
+            { text: 'Click Events', link: '/features/click-events' },
+            { text: 'Data Binding', link: '/features/data-binding' },
+            { text: 'Forms', link: '/features/forms' },
+            { text: 'Validation', link: '/features/validation' },
+            { text: 'Query String Binding', link: '/features/query-string' },
+            { text: 'Polling', link: '/features/polling' },
+            { text: 'Loading States', link: '/features/loading-states' },
+            { text: 'Error Handling', link: '/features/error-handling' },
+            { text: 'Component Events', link: '/features/component-events' },
+            { text: 'Redirects', link: '/features/redirects' },
+            { text: 'Pagination', link: '/features/pagination' }
           ]
         },
         {
-          text: 'Building UIs',
+          text: 'Advanced',
           items: [
-            { text: 'Directives', link: '/guide/directives' },
-            { text: 'Event Handling', link: '/guide/events' },
-            { text: 'Data Binding', link: '/guide/data-binding' },
-            { text: 'Forms', link: '/guide/forms' },
-            { text: 'Validation', link: '/guide/validation' }
+            { text: 'Component State', link: '/advanced/component-state' },
+            { text: 'Lifecycle Hooks', link: '/advanced/lifecycle-hooks' },
+            { text: 'Virtual DOM', link: '/advanced/virtual-dom' },
+            { text: 'Security', link: '/advanced/security' },
+            { text: 'Performance', link: '/advanced/performance' },
+            { text: 'Testing', link: '/advanced/testing' },
+            { text: 'WebSocket Transport', link: '/advanced/websocket' }
           ]
         },
-        {
-          text: 'Advanced Features',
-          items: [
-            { text: 'Query String Binding', link: '/guide/query-string' },
-            { text: 'Polling & Real-time', link: '/guide/polling' },
-            { text: 'Loading States', link: '/guide/loading-states' },
-            { text: 'Error Handling', link: '/guide/error-handling' },
-            { text: 'Component Events', link: '/guide/component-events' },
-            { text: 'Redirects', link: '/guide/redirects' }
-          ]
-        },
-        {
-          text: 'Advanced Topics',
-          items: [
-            { text: 'Security', link: '/guide/security' },
-            { text: 'Performance', link: '/guide/performance' },
-            { text: 'Testing', link: '/guide/testing' },
-            { text: 'WebSocket Transport', link: '/guide/websocket' }
-          ]
-        }
-      ],
-      '/examples/': [
         {
           text: 'Examples',
           items: [
             { text: 'Counter', link: '/examples/counter' },
             { text: 'Todo List', link: '/examples/todo-list' },
             { text: 'Contact Form', link: '/examples/contact-form' },
             { text: 'Search', link: '/examples/search' },
-            { text: 'Confirmation Modal', link: '/examples/confirmation-modal' }
+            { text: 'Confirmation Modal', link: '/examples/confirmation-modal' },
+            { text: 'Page Change Logger', link: '/examples/page-change-logger' }
           ]
         }
       ]
@@ -100,7 +88,7 @@ export default defineConfig({
 
     footer: {
       message: 'Released under the MIT License.',
-      copyright: 'Copyright © 2024 Diffyne'
+      copyright: 'Copyright © 2025 Diffyne'
     },
 
     search: {

docs/guide/index.md

@@ -99,5 +99,5 @@ Traditional server-side rendering sends full HTML on every interaction. Diffyne
 - **Interactive UIs** without writing JavaScript
 - **Real-time apps** with WebSocket support
 
-Ready to get started? [Read the guide →](/guide/)
+Ready to get started? [Read the guide →](/getting-started/installation)
 

docs/index.md

@@ -1,25 +1,53 @@
 #!/usr/bin/env node
 
-import { readFileSync, writeFileSync, mkdirSync, readdirSync, statSync, cpSync } from 'fs';
+import { readFileSync, writeFileSync, mkdirSync, readdirSync, statSync, cpSync, unlinkSync, rmdirSync } from 'fs';
 import { join, dirname, relative } from 'path';
 import { fileURLToPath } from 'url';
 
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 
-// Configuration
-// Default assumes docs repo is cloned as sibling directory
 const DOCS_SOURCE = process.env.DOCS_SOURCE_PATH || join(__dirname, '../../docs');
-const DOCS_TARGET = join(__dirname, '../docs/guide');
+const DOCS_TARGET = join(__dirname, '../docs');
 
 console.log('📚 Syncing documentation...');
 console.log(`Source: ${DOCS_SOURCE}`);
 console.log(`Target: ${DOCS_TARGET}`);
 
-// Ensure target directory exists
 mkdirSync(DOCS_TARGET, { recursive: true });
 
-// Function to recursively copy and convert markdown files
+function clearOldFiles(targetDir, isRoot = false) {
+  const entries = readdirSync(targetDir, { withFileTypes: true });
+  
+  for (const entry of entries) {
+    const entryPath = join(targetDir, entry.name);
+    
+    if (entry.isDirectory()) {
+      clearOldFiles(entryPath, false);
+      try {
+        const subEntries = readdirSync(entryPath);
+        if (subEntries.length === 0) {
+          rmdirSync(entryPath);
+        }
+      } catch (e) {
+      }
+    } else if (entry.isFile() && entry.name.endsWith('.md')) {
+      if (isRoot && entry.name === 'index.md') {
+        continue;
+      }
+      unlinkSync(entryPath);
+    }
+  }
+}
+
+console.log('🧹 Cleaning old files...');
+try {
+  if (readdirSync(DOCS_TARGET).length > 0) {
+    clearOldFiles(DOCS_TARGET, true);
+  }
+} catch (e) {
+}
+
 function syncDirectory(sourceDir, targetDir, basePath = '') {
   const entries = readdirSync(sourceDir, { withFileTypes: true });
 
@@ -28,37 +56,26 @@ function syncDirectory(sourceDir, targetDir, basePath = '') {
     const targetPath = join(targetDir, entry.name);
 
     if (entry.isDirectory()) {
-      // Skip certain directories
       if (entry.name === 'node_modules' || entry.name === '.git') {
         continue;
       }
 
       mkdirSync(targetPath, { recursive: true });
       syncDirectory(sourcePath, targetPath, join(basePath, entry.name));
     } else if (entry.isFile() && entry.name.endsWith('.md')) {
-      // Read source file
       let content = readFileSync(sourcePath, 'utf-8');
 
-      // Add VitePress frontmatter if not present
       if (!content.startsWith('---')) {
         const frontmatter = generateFrontmatter(entry.name, basePath);
         content = frontmatter + '\n\n' + content;
       }
 
-      // Fix relative links
-      content = fixLinks(content, basePath);
-      
-      // Fix syntax highlighting issues
-      content = fixSyntaxHighlighting(content);
-
-      // Write to target
       writeFileSync(targetPath, content, 'utf-8');
       console.log(`✓ Synced: ${join(basePath, entry.name)}`);
     }
   }
 }
 
-// Generate VitePress frontmatter
 function generateFrontmatter(filename, basePath) {
   const title = filename
     .replace('.md', '')
@@ -72,44 +89,6 @@ description: ${title} - Diffyne Documentation
 ---`;
 }
 
-// Fix relative links in markdown
-function fixLinks(content, basePath) {
-  // Fix ../ links
-  content = content.replace(/\]\(\.\.\//g, '](/guide/');
-  
-  // Fix ./ links in same directory
-  content = content.replace(/\]\(\.\//g, '](/guide/');
-  
-  // Fix links to other sections
-  content = content.replace(/\]\(([^)]+\.md)\)/g, (match, path) => {
-    // Convert relative paths to absolute guide paths
-    if (path.startsWith('../')) {
-      const relativePath = path.replace('../', '');
-      return `](/guide/${relativePath})`;
-    }
-    if (path.startsWith('./')) {
-      const relativePath = path.replace('./', '');
-      return `](/guide/${basePath}/${relativePath})`;
-    }
-    return match;
-  });
-
-  return content;
-}
-
-// Fix syntax highlighting issues
-function fixSyntaxHighlighting(content) {
-  // Replace 'env' language with 'bash' (VitePress doesn't support 'env')
-  content = content.replace(/```env\n/g, '```bash\n');
-  
-  // Remove any stray HTML closing tags that might break VitePress
-  // This is a safety measure for malformed markdown
-  content = content.replace(/^(\s*)<\/[a-z]+>\s*$/gm, '');
-  
-  return content;
-}
-
-// Start sync
 try {
   syncDirectory(DOCS_SOURCE, DOCS_TARGET);
   console.log('\n✅ Documentation sync complete!');