Skip to content

Commit c09df6a

Browse files
committed
Minor documentation improvements.
1 parent 638b6c7 commit c09df6a

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

context/best-practices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This guide outlines recommended patterns and practices for building robust, main
44

55
## Application Structure
66

7-
If you are creating an application that runs services, you should define a top level `services.rb` file:
7+
If you are creating an application that runs services, you should define a top level `services.rb` file that includes all your service configurations. This file serves as the main entry point for your services. If you are specifically working with the Falcon web server, this file is typically called `falcon.rb` for historical reasons.
88

99
### Service Configuration
1010

context/service-architecture.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This guide explains the key architectural components of `async-service` and how
1313

1414
## Environment
1515

16-
The {ruby Async::Service::Environment} represents a lazy-evaluated chain of key-value pairs. It handles:
16+
The {ruby Async::Service::Environment} represents a lazy-evaluated chain of key-value pairs. It handles configuration storage, lazy evaluation of computed values, and composition through module inclusion to create flexible, reusable service configurations.
1717

1818
### Configuration Storage
1919

@@ -82,7 +82,7 @@ end
8282

8383
## Service
8484

85-
The {ruby Async::Service::Generic} represents the service implementation layer. It handles:
85+
The {ruby Async::Service::Generic} represents the service implementation layer. It handles the actual business logic of your services, provides access to configuration through environment evaluators, and manages the service lifecycle including startup, execution, and shutdown phases.
8686

8787
### Business Logic
8888

@@ -172,7 +172,7 @@ end
172172

173173
## Configuration
174174

175-
The {ruby Async::Service::Configuration} represents the top-level orchestration layer. It handles:
175+
The {ruby Async::Service::Configuration} represents the top-level orchestration layer. It handles service definition and registration, provides service discovery and management capabilities, supports loading configurations from files, and enables introspection of defined services and their settings.
176176

177177
### Service Definitions
178178

guides/service-architecture/readme.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This guide explains the key architectural components of `async-service` and how
1313

1414
## Environment
1515

16-
The {ruby Async::Service::Environment} represents a lazy-evaluated chain of key-value pairs. It handles:
16+
The {ruby Async::Service::Environment} represents a lazy-evaluated chain of key-value pairs. It handles configuration storage, lazy evaluation of computed values, and composition through module inclusion to create flexible, reusable service configurations.
1717

1818
### Configuration Storage
1919

@@ -82,7 +82,7 @@ end
8282

8383
## Service
8484

85-
The {ruby Async::Service::Generic} represents the service implementation layer. It handles:
85+
The {ruby Async::Service::Generic} represents the service implementation layer. It handles the actual business logic of your services, provides access to configuration through environment evaluators, and manages the service lifecycle including startup, execution, and shutdown phases.
8686

8787
### Business Logic
8888

@@ -172,7 +172,7 @@ end
172172

173173
## Configuration
174174

175-
The {ruby Async::Service::Configuration} represents the top-level orchestration layer. It handles:
175+
The {ruby Async::Service::Configuration} represents the top-level orchestration layer. It handles service definition and registration, provides service discovery and management capabilities, supports loading configurations from files, and enables introspection of defined services and their settings.
176176

177177
### Service Definitions
178178

0 commit comments

Comments
 (0)