doc(main): Updated documentation (#276)

ankorstore · Jul 26, 2024 · 446bb92 · 446bb92
1 parent bee6938
commit 446bb92
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 8 deletions.
diff --git a/docs/modules/fxconfig.md b/docs/modules/fxconfig.md
@@ -41,6 +41,7 @@ For the following examples, we will be considering those configuration files:
 ```yaml title="configs/config.yaml"
 app:
   name: app
+  description: app description
   env: dev
   version: 0.1.0
   debug: false
@@ -93,10 +94,11 @@ func NewExampleService(config *config.Config) *ExampleService {
 
 func (s *ExampleService) PrintConfig() {
 	// helpers
-	fmt.Printf("name: %s", s.config.AppName())       // name: app
-	fmt.Printf("env: %s", s.config.AppEnv())         // env: dev
-	fmt.Printf("version: %s", s.config.AppVersion()) // version: 0.1.0
-	fmt.Printf("debug: %v", s.config.AppDebug())     // debug: false
+	fmt.Printf("name: %s", s.config.AppName())               // name: app
+	fmt.Printf("description: %s", s.config.AppDescription()) // description: app description
+	fmt.Printf("env: %s", s.config.AppEnv())                 // env: dev
+	fmt.Printf("version: %s", s.config.AppVersion())         // version: 0.1.0
+	fmt.Printf("debug: %v", s.config.AppDebug())             // debug: false
 
 	// others
 	fmt.Printf("string_value: %s", s.config.GetString("config.values.string_value")) // string_value: default
@@ -118,10 +120,11 @@ If you run your application in `test` mode:
 // helpers
 fmt.Printf("var: %s", s.config.GetEnvVar("APP_ENV")) // var: test
 
-fmt.Printf("name: %s", s.config.AppName())           // name: app
-fmt.Printf("env: %s", s.config.AppEnv())             // env: test
-fmt.Printf("version: %s", s.config.AppVersion())     // version: 0.1.0
-fmt.Printf("debug: %v", s.config.AppDebug())         // debug: true
+fmt.Printf("name: %s", s.config.AppName())               // name: app
+fmt.Printf("description: %s", s.config.AppDescription()) // description: app description
+fmt.Printf("env: %s", s.config.AppEnv())                 // env: test
+fmt.Printf("version: %s", s.config.AppVersion())         // version: 0.1.0
+fmt.Printf("debug: %v", s.config.AppDebug())             // debug: true
 
 // others
 fmt.Printf("string_value: %s", s.config.GetString("config.values.string_value")) // string_value: test

diff --git a/docs/modules/fxcore.md b/docs/modules/fxcore.md
@@ -53,6 +53,7 @@ modules:
       dashboard:
         enabled: true                  # to enable the core dashboard
         overview:      
+          app_description: true        # to display the app description on the dashboard overview
           app_env: true                # to display the app env on the dashboard overview
           app_debug: true              # to display the app debug on the dashboard overview
           app_version: true            # to display the app version on the dashboard overview