🗄 Docs started & API reference structure done

Author: Daniel Requejo

docs/.vitepress/config.cts

@@ -5,6 +5,10 @@ export default defineConfig({
   description: 'Discover the easy way of handling your vue forms',
   themeConfig: {
     logo: '/favicon.svg',
+    editLink: {
+      pattern: 'https://github.com/dbssman/vue-form-handler/edit/master/docs/:path',
+      text: 'Edit this page on GitHub',
+    },
     nav: [
       { text: 'Home', link: '/' },
       { text: 'Get started', link: '/get-started' },
@@ -37,7 +41,23 @@ export default defineConfig({
       },
       {
         text: 'API Reference', items: [
-          { text: 'useFormHandler()', link: '/api/use-form-handler' },
+          {
+            text: 'useFormHandler', link: '/api/use-form-handler/index', items: [
+              { text: 'clearError', link: '/api/use-form-handler/clear-error' },
+              { text: 'clearField', link: '/api/use-form-handler/clear-field' },
+              { text: 'formState', link: '/api/use-form-handler/form-state' },
+              { text: 'handleSubmit', link: '/api/use-form-handler/handle-submit' },
+              { text: 'modifiedValues', link: '/api/use-form-handler/modified-values' },
+              { text: 'register', link: '/api/use-form-handler/register' },
+              { text: 'resetField', link: '/api/use-form-handler/reset-field' },
+              { text: 'resetForm', link: '/api/use-form-handler/reset-form' },
+              { text: 'setError', link: '/api/use-form-handler/set-error' },
+              { text: 'setValue', link: '/api/use-form-handler/set-value' },
+              { text: 'triggerValidation', link: '/api/use-form-handler/trigger-validation' },
+              { text: 'unregister', link: '/api/use-form-handler/unregister' },
+              { text: 'values', link: '/api/use-form-handler/values' },
+            ]
+          },
           { text: `FormHandler`, link: '/api/form-handler' }
         ]
       }

docs/api/use-form-handler/clear-error.md

@@ -0,0 +1 @@
+# clearError

docs/api/use-form-handler/clear-field.md

@@ -0,0 +1 @@
+# clearField

docs/api/use-form-handler/form-state.md

@@ -0,0 +1 @@
+# formState

docs/api/use-form-handler/handle-submit.md

@@ -0,0 +1 @@
+# handleSubmit

docs/api/use-form-handler.md docs/api/use-form-handler/index.md

@@ -0,0 +1 @@
+# modifiedValues

docs/api/use-form-handler/modified-values.md

@@ -0,0 +1 @@
+# register

docs/api/use-form-handler/register.md

@@ -0,0 +1 @@
+# resetField

docs/api/use-form-handler/reset-field.md

@@ -0,0 +1 @@
+# resetForm

docs/api/use-form-handler/reset-form.md

@@ -0,0 +1 @@
+# setError

docs/api/use-form-handler/set-error.md

@@ -0,0 +1 @@
+# setValue

docs/api/use-form-handler/set-value.md

@@ -0,0 +1 @@
+# triggerValidation

docs/api/use-form-handler/trigger-validation.md

@@ -0,0 +1 @@
+# unregister

docs/api/use-form-handler/unregister.md

@@ -0,0 +1 @@
+# values

docs/api/use-form-handler/values.md

@@ -17,14 +17,14 @@ hero:
       link: https://github.com/dbssman/vue-form-handler
 
 features:
-  - title: Fully tree shakeable
-    details: Only take what you want
-    icon: ⚡
+  - title: Performant
+    details: Great performance even with big and complex forms
+    icon: 🏎
   - title: Type Strong
     details: Written in TypeScript, with full TS docs
     icon: 💪
   - title: Flexible
-    details: You can wrap the handler over native inputs or any other like the ones from material libraries or custom inputs
+    details: Use on top of native inputs, custom inputs or material libraries!
     icon: 🔩
   - title: Super light
     details: Small package size
@@ -33,6 +33,6 @@ features:
     details: Great development experience
     icon: 💻
   - title: Interactive demos
-    details: Documentation of functions also come with interactive demos!
+    details: Coming soon...
     icon: 🎪
 ---

docs/index.md

@@ -1,7 +1,10 @@
 {
+  "author": "Dennis R. Bosmans",
   "name": "vue-form-handler",
-  "private": true,
-  "version": "0.0.0",
+  "description": "Vue 3 form handler, with validation, error handling, and more.",
+  "license": "MIT",
+  "private": false,
+  "version": "1.0.0",
   "type": "module",
   "files": [
     "dist"