docs: Update on validate feature and CLI helper (#80)

Co-authored-by: Germain LEFEBVRE <germain.lefebvre@external.waykonect.com>

Author: germainlefebvre4

.pre-commit-config.yaml

@@ -20,6 +20,11 @@ repos:
         entry: bash -c 'mockery'
         language: system
         verbose: false
+      - id: cli-helper
+        name: cli-helper
+        entry: bash -c 'go run ./cmd/cvwonder > docs/github-pages/static/helper.out'
+        language: system
+        verbose: true
       # - id: cvwonder-documentation
       #   name: cvwonder-documentation
       #   entry: bash -c 'cd docs/github-pages && pnpm build'

cmd/cvwonder/main.go

@@ -30,10 +30,10 @@ func main() {
 		Long:    `CV Wonder - Generate your CV with Wonder!`,
 	}
 
-	rootCmd.PersistentFlags().StringVarP(&utils.CliArgs.InputFile, "input", "i", "cv.yml", "Input file in YAML format (required). Default is 'cv.yml'")
-	rootCmd.PersistentFlags().StringVarP(&utils.CliArgs.OutputDirectory, "output", "o", "generated/", "Output directory (optional). Default is 'generated/'")
-	rootCmd.PersistentFlags().StringVarP(&utils.CliArgs.ThemeName, "theme", "t", "default", "Name of the theme (optional). Default is 'default'.")
-	rootCmd.PersistentFlags().StringVarP(&utils.CliArgs.Format, "format", "f", "html", "Format for the export (optional). Default is 'html'.")
+	rootCmd.PersistentFlags().StringVarP(&utils.CliArgs.InputFile, "input", "i", "cv.yml", "Input file in YAML format.")
+	rootCmd.PersistentFlags().StringVarP(&utils.CliArgs.OutputDirectory, "output", "o", "generated/", "Output directory.")
+	rootCmd.PersistentFlags().StringVarP(&utils.CliArgs.ThemeName, "theme", "t", "default", "Name of the theme.")
+	rootCmd.PersistentFlags().StringVarP(&utils.CliArgs.Format, "format", "f", "html", "Format for the export.")
 	rootCmd.PersistentFlags().BoolVarP(&utils.CliArgs.Debug, "debug", "d", false, "Debug mode: more verbose.")
 
 	rootCmd.AddCommand(cmdGenerate.GenerateCmd())

cmd/cvwonder/serve/main.go

@@ -87,7 +87,7 @@ func ServeCmd() *cobra.Command {
 			serveService.StartLiveReloader(utils.CliArgs.Port, outputDir.FullPath, inputFile.FullPath)
 		},
 	}
-	cobraCmd.Flags().BoolVarP(&utils.CliArgs.Browser, "browser", "b", false, "Open the browser (optional). Default is 'false'.")
+	cobraCmd.Flags().BoolVarP(&utils.CliArgs.Browser, "browser", "b", false, "Open the browser.")
 	cobraCmd.Flags().BoolVarP(&utils.CliArgs.Watch, "watch", "w", false, "Watch for file changes")
 	cobraCmd.Flags().IntVarP(&utils.CliArgs.Port, "port", "p", 3000, "Listening port for local server")
 

cmd/cvwonder/themes/main.go

@@ -76,7 +76,7 @@ func CmdCreate() *cobra.Command {
 		},
 	}
 
-	cobraCmd.Flags().StringVarP(&utils.CliArgs.CreateThemeName, "name", "n", "New Theme", "Name of the new theme (required). Default is 'New Theme'")
+	cobraCmd.Flags().StringVarP(&utils.CliArgs.CreateThemeName, "name", "n", "New Theme", "Name of the new theme.")
 
 	return cobraCmd
 }

docs/dockerhub/README.md

@@ -51,14 +51,17 @@ Available Commands:
   help        Help about any command
   serve       Generate and serve the CV
   themes      Manage themes
+  validate    Validate the CV YAML file
+  version     Show version
 
 Flags:
-  -f, --format string   Format for the export (optional). Default is 'html'. (default "html")
+  -d, --debug           Debug mode: more verbose.
+  -f, --format string   Format for the export. (default "html")
   -h, --help            help for cvwonder
-  -i, --input string    Input file in YAML format (required). Default is 'cv.yml' (default "cv.yml")
-  -o, --output string   Output directory (optional). Default is 'generated/' (default "generated/")
-  -t, --theme string    Name of the theme (optional). Default is 'default'. (default "default")
-  -v, --verbose         Debug mode.
+  -i, --input string    Input file in YAML format. (default "cv.yml")
+  -o, --output string   Output directory. (default "generated/")
+  -t, --theme string    Name of the theme. (default "default")
+  -v, --version         version for cvwonder
 
 Use "cvwonder [command] --help" for more information about a command.
 ```

docs/github-pages/docs/validation/schema-reference.md

@@ -5,6 +5,10 @@ sidebar_position: 3
 
 ---
 
+:::info
+Available since `v0.5.0`
+:::
+
 The validator uses a JSON Schema to define the CV structure. Key validation rules:
 
 ### Required Fields

docs/github-pages/docs/validation/schema.md

@@ -3,6 +3,9 @@ sidebar_position: 2
 ---
 # Schema
 
+:::info
+Available since `v0.5.0`
+:::
 
 ## View Schema
 

docs/github-pages/docs/validation/validate.md

@@ -6,9 +6,11 @@ sidebar_position: 1
 ---
 
 :::info
-Consider validating your CV file before generating to ensure quality and correctness.
+Available since `v0.5.0`
 :::
 
+Validation is a crucial step in ensuring the integrity and correctness of your CV data. CVWonder provides built-in validation features to help you catch errors and inconsistencies before generating your CV.
+
 ## Getting Started
 
 ### Basic Validation

docs/github-pages/static/helper.out

@@ -9,15 +9,16 @@ Available Commands:
   help        Help about any command
   serve       Generate and serve the CV
   themes      Manage themes
+  validate    Validate the CV YAML file
   version     Show version
 
 Flags:
   -d, --debug           Debug mode: more verbose.
-  -f, --format string   Format for the export (optional). Default is 'html'. (default "html")
+  -f, --format string   Format for the export. (default "html")
   -h, --help            help for cvwonder
-  -i, --input string    Input file in YAML format (required). Default is 'cv.yml' (default "cv.yml")
-  -o, --output string   Output directory (optional). Default is 'generated/' (default "generated/")
-  -t, --theme string    Name of the theme (optional). Default is 'default'. (default "default")
+  -i, --input string    Input file in YAML format. (default "cv.yml")
+  -o, --output string   Output directory. (default "generated/")
+  -t, --theme string    Name of the theme. (default "default")
   -v, --version         version for cvwonder
 
 Use "cvwonder [command] --help" for more information about a command.