fix: docs

nicolabovolato · May 1, 2024 · ac8c2d8 · ac8c2d8
1 parent 3759e43
commit ac8c2d8
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -37,7 +37,8 @@ const container = new IocContainer()
 const app = new AppBuilder(container)
   // Lifecycle management
   .configureLifecycle((b, c) => b
-    .addHealthcheck("svc", (c) => c.svc)   // Healthchecks
+    // Healthchecks
+    .addHealthcheck("svc", (c) => c.svc)
     // Plugins
     .with(lifecyclePlugin, (b) => b
       .addFastifyEntrypoint("http", (f) => f

diff --git a/packages/docs/docs/core-concepts/healthchecks.mdx b/packages/docs/docs/core-concepts/healthchecks.mdx
@@ -15,7 +15,7 @@ such as a database query to check if connectivity works.
 In Basica, they can be easily added in all your services by implementing `IHealthcheck`.
 
 :::note
-Services and Entrypoint registered in the lifecycle will automatically be registered as healthchecks if they have a healthcheck function.
+Any registered service or entrypoint implementing `IHealthcheck` will also be registered as an healthcheck.
 :::
 
 ## Implementing IHealthcheck

diff --git a/packages/docs/src/pages/index.tsx b/packages/docs/src/pages/index.tsx
@@ -92,7 +92,8 @@ const container = new IocContainer()
 const app = new AppBuilder(container)
   // Lifecycle management
   .configureLifecycle((b, c) => b
-    .addHealthcheck("svc", (c) => c.svc)   // Healthchecks
+    // Healthchecks
+    .addHealthcheck("svc", (c) => c.svc)
     // Plugins
     .with(lifecyclePlugin, (b) => b
       .addFastifyEntrypoint("http", (f) => f
@@ -141,7 +142,7 @@ export default function Home(): JSX.Element {
               Seamless integration with your favorite library
             </Card>
             <Card title={"Healthchecks"} icon={<Icon name="heartbeat" />}>
-              Check on a glance if your service up and running
+              Check on a glance if your service is up and running
             </Card>
             <Card title={"Structured logging"} icon={<Icon name="brackets" />}>
               Fast, structured logging provided by Pino