From 69747a65a934bad73b74f361393b943d61e09b6f Mon Sep 17 00:00:00 2001 From: Artur Shiriev Date: Sun, 5 Jul 2026 00:15:49 +0300 Subject: [PATCH] docs: fix broken list on home page, dead links, and typos The intro list on the home page rendered as a run-together paragraph because python-markdown requires a blank line before a list; add it. Repoint the home-page integration links and every integration page's "Read more" links to correct `.md`-relative targets (the old `../../../introduction/...` paths were the wrong depth, missing `.md`, and only worked via a host redirect). Fix typos ("build you" -> "build your", "choosen" -> "chosen", "Fastapi" -> "FastAPI") and document the missing `prometheus_group_path` Litestar config field. Mirror the blank-line fix in README for parity. Co-Authored-By: Claude Opus 4.8 (1M context) --- README.md | 1 + docs/index.md | 11 ++++++----- docs/integrations/fastapi.md | 8 ++++---- docs/integrations/fastmcp.md | 4 ++-- docs/integrations/faststream.md | 6 +++--- docs/integrations/free.md | 6 +++--- docs/integrations/litestar.md | 6 +++--- docs/introduction/configuration.md | 1 + docs/introduction/installation.md | 2 +- 9 files changed, 24 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index a85bc70..704d52a 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@ `lite-bootstrap` wires production observability — OpenTelemetry, Prometheus, Sentry, and structlog — into FastAPI, Litestar, and FastStream services in a few lines, with no boilerplate. With `lite-bootstrap`, you receive an application with lightweight built-in support for: + - `sentry` - `prometheus` - `opentelemetry` diff --git a/docs/index.md b/docs/index.md index df76f71..3150e4a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,6 +5,7 @@ Welcome to the `lite-bootstrap` documentation! `lite-bootstrap` assists you in creating applications with all the necessary instruments already set up. With `lite-bootstrap`, you receive an application with lightweight built-in support for: + - `sentry` - `prometheus` - `opentelemetry` @@ -16,9 +17,9 @@ With `lite-bootstrap`, you receive an application with lightweight built-in supp Those instruments can be bootstrapped for: -- [LiteStar](integrations/litestar) -- [FastStream](integrations/faststream) -- [FastAPI](integrations/fastapi) -- [FastMCP](integrations/fastmcp) -- [services and scripts without frameworks](integrations/free) +- [LiteStar](integrations/litestar.md) +- [FastStream](integrations/faststream.md) +- [FastAPI](integrations/fastapi.md) +- [FastMCP](integrations/fastmcp.md) +- [services and scripts without frameworks](integrations/free.md) --- diff --git a/docs/integrations/fastapi.md b/docs/integrations/fastapi.md index b75892c..44da1b2 100644 --- a/docs/integrations/fastapi.md +++ b/docs/integrations/fastapi.md @@ -1,4 +1,4 @@ -# Usage with `Fastapi` +# Usage with `FastAPI` *Another example of usage with FastAPI - [fastapi-sqlalchemy-template](https://github.com/modern-python/fastapi-sqlalchemy-template)* @@ -22,9 +22,9 @@ poetry add lite-bootstrap[fastapi-all] ``` -Read more about available extras [here](../../../introduction/installation): +Read more about available extras [here](../introduction/installation.md). -## 2. Define bootstrapper config and build you application: +## 2. Define bootstrapper config and build your application: ```python from lite_bootstrap import FastAPIConfig, FastAPIBootstrapper @@ -45,4 +45,4 @@ bootstrapper = FastAPIBootstrapper(bootstrapper_config) application = bootstrapper.bootstrap() ``` -Read more about available configuration options [here](../../../introduction/configuration): +Read more about available configuration options [here](../introduction/configuration.md). diff --git a/docs/integrations/fastmcp.md b/docs/integrations/fastmcp.md index 9d90b3a..2fce791 100644 --- a/docs/integrations/fastmcp.md +++ b/docs/integrations/fastmcp.md @@ -20,7 +20,7 @@ poetry add lite-bootstrap[fastmcp-all] ``` -Read more about available extras [here](../../../introduction/installation): +Read more about available extras [here](../introduction/installation.md). ## 2. Define bootstrapper config and build your application: @@ -54,4 +54,4 @@ Teardown is wired through FastMCP's provider lifecycle — `bootstrapper.teardow runs automatically when the FastMCP server's ASGI lifespan shuts down (i.e. when the application that serves `application.http_app()` shuts down). -Read more about available configuration options [here](../../../introduction/configuration): +Read more about available configuration options [here](../introduction/configuration.md). diff --git a/docs/integrations/faststream.md b/docs/integrations/faststream.md index 3b67c6a..ae7cd61 100644 --- a/docs/integrations/faststream.md +++ b/docs/integrations/faststream.md @@ -20,9 +20,9 @@ poetry add lite-bootstrap[faststream-all] ``` -Read more about available extras [here](../../../introduction/installation): +Read more about available extras [here](../introduction/installation.md). -## 2. Define bootstrapper config and build you application: +## 2. Define bootstrapper config and build your application: ```python from lite_bootstrap import FastStreamConfig, FastStreamBootstrapper @@ -50,4 +50,4 @@ bootstrapper = FastStreamBootstrapper(bootstrapper_config) application = bootstrapper.bootstrap() ``` -Read more about available configuration options [here](../../../introduction/configuration): +Read more about available configuration options [here](../introduction/configuration.md). diff --git a/docs/integrations/free.md b/docs/integrations/free.md index 9656f0f..acf61e2 100644 --- a/docs/integrations/free.md +++ b/docs/integrations/free.md @@ -20,9 +20,9 @@ poetry add lite-bootstrap[free-all] ``` -Read more about available extras [here](../../../introduction/installation): +Read more about available extras [here](../introduction/installation.md). -## 2. Define bootstrapper config and build you application: +## 2. Define bootstrapper config and build your application: ```python from lite_bootstrap import FreeBootstrapperConfig, FreeBootstrapper @@ -36,4 +36,4 @@ bootstrapper = FreeBootstrapper(bootstrapper_config) bootstrapper.bootstrap() ``` -Read more about available configuration options [here](../../../introduction/configuration): +Read more about available configuration options [here](../introduction/configuration.md). diff --git a/docs/integrations/litestar.md b/docs/integrations/litestar.md index 20cf745..25a8bf6 100644 --- a/docs/integrations/litestar.md +++ b/docs/integrations/litestar.md @@ -22,9 +22,9 @@ poetry add lite-bootstrap[litestar-all] ``` -Read more about available extras [here](../../../introduction/installation): +Read more about available extras [here](../introduction/installation.md). -## 2. Define bootstrapper config and build you application: +## 2. Define bootstrapper config and build your application: ```python from lite_bootstrap import LitestarConfig, LitestarBootstrapper @@ -45,7 +45,7 @@ bootstrapper = LitestarBootstrapper(bootstrapper_config) application = bootstrapper.bootstrap() ``` -Read more about available configuration options [here](../../../introduction/configuration): +Read more about available configuration options [here](../introduction/configuration.md). ## Logging diff --git a/docs/introduction/configuration.md b/docs/introduction/configuration.md index d4cc875..80b1580 100644 --- a/docs/introduction/configuration.md +++ b/docs/introduction/configuration.md @@ -40,6 +40,7 @@ Prometheus's integration for Litestar requires `prometheus_client` package. Additional parameters for Litestar integration: +- `prometheus_group_path` - defaults to `True` so the `path` metric label uses the route template (`/users/{id}`) instead of the raw URL, bounding metric cardinality. Set to `False` to record raw paths. - `prometheus_additional_params` - passed to `litestar.plugins.prometheus.PrometheusConfig`. ### Prometheus FastStream diff --git a/docs/introduction/installation.md b/docs/introduction/installation.md index 1e283d5..cb90e19 100644 --- a/docs/introduction/installation.md +++ b/docs/introduction/installation.md @@ -19,7 +19,7 @@ You can choose required framework and instruments using this table: * not used - means that the instrument is not implemented in the integration. * no extra - means that the instrument requires no additional dependencies. -## Install `lite-bootstrap` using your favorite tool with choosen extras +## Install `lite-bootstrap` using your favorite tool with chosen extras For example, if you want to bootstrap litestar with structlog and opentelemetry instruments: