Skip to content

Commit 446bb92

Browse files
authored
doc(main): Updated documentation (#276)
1 parent bee6938 commit 446bb92

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

docs/modules/fxconfig.md

+11-8
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ For the following examples, we will be considering those configuration files:
4141
```yaml title="configs/config.yaml"
4242
app:
4343
name: app
44+
description: app description
4445
env: dev
4546
version: 0.1.0
4647
debug: false
@@ -93,10 +94,11 @@ func NewExampleService(config *config.Config) *ExampleService {
9394
9495
func (s *ExampleService) PrintConfig() {
9596
// helpers
96-
fmt.Printf("name: %s", s.config.AppName()) // name: app
97-
fmt.Printf("env: %s", s.config.AppEnv()) // env: dev
98-
fmt.Printf("version: %s", s.config.AppVersion()) // version: 0.1.0
99-
fmt.Printf("debug: %v", s.config.AppDebug()) // debug: false
97+
fmt.Printf("name: %s", s.config.AppName()) // name: app
98+
fmt.Printf("description: %s", s.config.AppDescription()) // description: app description
99+
fmt.Printf("env: %s", s.config.AppEnv()) // env: dev
100+
fmt.Printf("version: %s", s.config.AppVersion()) // version: 0.1.0
101+
fmt.Printf("debug: %v", s.config.AppDebug()) // debug: false
100102
101103
// others
102104
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:
118120
// helpers
119121
fmt.Printf("var: %s", s.config.GetEnvVar("APP_ENV")) // var: test
120122
121-
fmt.Printf("name: %s", s.config.AppName()) // name: app
122-
fmt.Printf("env: %s", s.config.AppEnv()) // env: test
123-
fmt.Printf("version: %s", s.config.AppVersion()) // version: 0.1.0
124-
fmt.Printf("debug: %v", s.config.AppDebug()) // debug: true
123+
fmt.Printf("name: %s", s.config.AppName()) // name: app
124+
fmt.Printf("description: %s", s.config.AppDescription()) // description: app description
125+
fmt.Printf("env: %s", s.config.AppEnv()) // env: test
126+
fmt.Printf("version: %s", s.config.AppVersion()) // version: 0.1.0
127+
fmt.Printf("debug: %v", s.config.AppDebug()) // debug: true
125128
126129
// others
127130
fmt.Printf("string_value: %s", s.config.GetString("config.values.string_value")) // string_value: test

docs/modules/fxcore.md

+1
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ modules:
5353
dashboard:
5454
enabled: true # to enable the core dashboard
5555
overview:
56+
app_description: true # to display the app description on the dashboard overview
5657
app_env: true # to display the app env on the dashboard overview
5758
app_debug: true # to display the app debug on the dashboard overview
5859
app_version: true # to display the app version on the dashboard overview

0 commit comments

Comments
 (0)