docs: update docs

Author: Degfy

README.md

@@ -56,10 +56,8 @@ func (c *Component) Init() {
 - Provides [scaffolding tool gonectl](https://github.com/gone-io/gonectl) supporting project creation, component management, code generation, test mocking, compilation and running.
 
 ### Architecture
-<img src="docs/assert/architecture.png" width = "600" alt="architecture"/>
+<img src="docs/assert/architecture.png" width = "800" alt="architecture"/>
 
-### Lifecycle
-<img src="docs/assert/flow.png" width = "600" alt="flow"/>
 
 ## 🏁 Quick Start
 

README_CN.md

@@ -57,8 +57,7 @@ func (c *Component) Init() {
 ### 架构
 <img src="docs/assert/architecture.png" width = "600" alt="architecture"/>
 
-### 生命周期
-<img src="docs/assert/flow.png" width = "600" alt="flow"/>
+
 
 ## 🏁 快速开始
 

config.go

@@ -18,13 +18,18 @@ type Configure interface {
 	Get(key string, v any, defaultVal string) error
 }
 
+// ConfWatchFunc defines the callback function for configuration changes
+type ConfWatchFunc func(oldVal, newVal any)
+
+// DynamicConfigure defines the interface for dynamic configuration providers
 type DynamicConfigure interface {
 	Configure
+
+	// Notify registers a callback function to be called when the specified key changes
 	Notify(key string, callback ConfWatchFunc)
 }
 
-type ConfWatchFunc func(oldVal, newVal any)
-
+// ConfWatcher which can be injected, to register a callback function to be called when the specified key changes
 type ConfWatcher func(key string, callback ConfWatchFunc)
 
 type confWatcherProvider struct {

docs/assert/architecture.png

@@ -13,6 +13,7 @@ const (
 	ErrorLevel LoggerLevel = 2
 )
 
+// Logger Interface which can be injected and provided by gone framework core
 type Logger interface {
 	Infof(msg string, args ...any)
 	Errorf(msg string, args ...any)