docs: improve structure

victorgarciaesgi · Dec 15, 2024 · aa9e8ba · aa9e8ba
1 parent ad40641
commit aa9e8ba
Show file tree

Hide file tree

Showing 5 changed files with 96 additions and 489 deletions.
diff --git a/README.md b/README.md
@@ -61,8 +61,8 @@ Special thank you for [Martins Zeltins](https://github.com/martinszeltins) who h
 
 - [x] Unit tests
 - [x] E2E tests
-- [ ] Example repo, Reproduction repl
-- [ ] Type tests
+- [x] Example repo, Reproduction repl
+- [x] Type tests
 
 ### Next iterations
 

diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -71,14 +71,24 @@ const Integrations: (DefaultTheme.NavItemWithLink | DefaultTheme.NavItemChildren
   },
 ];
 
-const Examples: DefaultTheme.NavItemWithLink[] = [
-    { text: 'Simple form example', link: '/examples/simple' },
-    { text: 'Custom rules', link: '/examples/custom-rules' },
-    { text: 'Conditional rules', link: '/examples/conditional-rules' },
-    { text: 'Collections', link: '/examples/collections' },
-    { text: 'Server validation', link: '/examples/server-validation' },
-    { text: 'Required indicators', link: '/examples/required-indicators' },
-    { text: 'Advanced form example', link: '/examples/advanced' },
+const Examples: (DefaultTheme.NavItemWithLink | DefaultTheme.NavItemChildren)[] = [
+  {
+    text: 'Complete',
+    items: [
+      { text: 'Simple form example', link: '/examples/simple' },
+      { text: 'Advanced form example', link: '/examples/advanced' },
+    ],
+  },
+  {
+    text: 'Specific',
+    items: [
+      { text: 'Custom rules', link: '/examples/custom-rules' },
+      { text: 'Conditional rules', link: '/examples/conditional-rules' },
+      { text: 'Collections', link: '/examples/collections' },
+      { text: 'Server validation', link: '/examples/server-validation' },
+      { text: 'Required indicators', link: '/examples/required-indicators' },
+    ],
+  },
 ];
 
 const Troubleshooting: DefaultTheme.NavItemWithLink[] = [

diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts
@@ -41,6 +41,6 @@ function scrollToActiveSidebarItem() {
       if (activeLink) {
         activeLink.scrollIntoView({ behavior: 'smooth', block: 'center' });
       }
-    }, 1000);
+    }, 400);
   }
 }
diff --git a/docs/src/examples/advanced.md b/docs/src/examples/advanced.md
@@ -16,4 +16,4 @@ Don't forgot to install the `Vue` extension in the online IDE.
 </a>
 
 
-<iframe style='width: 100%; height: 700px' src="https://stackblitz.com/github/victorgarciaesgi/regle-examples/tree/main/examples/advanced-example??embed=1&file=src%2FApp.vue&theme=dark&view=preview" title="Sandbox editor" sandbox="allow-modals allow-forms allow-popups allow-scripts allow-same-origin"></iframe>
+<iframe style='width: 100%; height: 700px' src="https://stackblitz.com/github/victorgarciaesgi/regle-examples/tree/main/examples/advanced-example?embed=1&file=src%2FApp.vue&theme=dark&view=preview" title="Sandbox editor" sandbox="allow-modals allow-forms allow-popups allow-scripts allow-same-origin"></iframe>
Original file line number	Diff line number	Diff line change
Expand Up		@@ -16,4 +16,4 @@ Don't forgot to install the `Vue` extension in the online IDE.
		</a>


		<iframe style='width: 100%; height: 700px' src="https://stackblitz.com/github/victorgarciaesgi/regle-examples/tree/main/examples/advanced-example??embed=1&file=src%2FApp.vue&theme=dark&view=preview" title="Sandbox editor" sandbox="allow-modals allow-forms allow-popups allow-scripts allow-same-origin"></iframe>
		<iframe style='width: 100%; height: 700px' src="https://stackblitz.com/github/victorgarciaesgi/regle-examples/tree/main/examples/advanced-example?embed=1&file=src%2FApp.vue&theme=dark&view=preview" title="Sandbox editor" sandbox="allow-modals allow-forms allow-popups allow-scripts allow-same-origin"></iframe>