diff --git a/README.md b/README.md index 00eaa5f9..a517bd38 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,25 @@ # Pydantic Logfire — Uncomplicated Observability -[![CI](https://github.com/pydantic/logfire/actions/workflows/main.yml/badge.svg?event=push)](https://github.com/pydantic/logfire/actions?query=event%3Apush+branch%3Amain+workflow%3ACI) -[![codecov](https://codecov.io/gh/pydantic/logfire/graph/badge.svg?token=735CNGCGFD)](https://codecov.io/gh/pydantic/logfire) -[![pypi](https://img.shields.io/pypi/v/logfire.svg)](https://pypi.python.org/pypi/logfire) -[![license](https://img.shields.io/github/license/pydantic/logfire.svg)](https://github.com/pydantic/logfire/blob/main/LICENSE) -[![versions](https://img.shields.io/pypi/pyversions/logfire.svg)](https://github.com/pydantic/logfire) +

+ + CI + + + codecov + + + pypi + + + license + + + versions + + + Join Slack + +

From the team behind Pydantic, **Logfire** is an observability platform built on the same belief as our open source library — that the most powerful tools can be easy to use. diff --git a/docs/index.md b/docs/index.md index 3dc8387b..fc14c9cc 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,12 +1,14 @@ -# Pydantic Logfire +# Getting Started + +## About Logfire From the team behind **Pydantic**, **Logfire** is a new type of observability platform built on the same belief as our open source library — that the most powerful tools can be easy to use. -**Logfire** is built on OpenTelemetry, and supports monitoring your application from any language, +**Logfire** is built on OpenTelemetry, and supports monitoring your application from **any language**, with particularly great support for Python! [Read more](why.md). -## Getting Started +## Overview This page is a quick walk-through for setting up a Python app: diff --git a/docs/plugins/main.py b/docs/plugins/main.py index 6fbde3ae..3a4ecaf9 100644 --- a/docs/plugins/main.py +++ b/docs/plugins/main.py @@ -92,7 +92,6 @@ def install_logfire(markdown: str, page: Page) -> str: # Split them and strip quotes for each one separately. extras = [arg.strip('\'"') for arg in arguments[1].strip('[]').split(',')] if len(arguments) > 1 else [] package = 'logfire' if not extras else f"'logfire[{','.join(extras)}]'" - extras_arg = ' '.join(f'-E {extra}' for extra in extras) instructions = [ '=== "pip"', ' ```bash', @@ -102,10 +101,6 @@ def install_logfire(markdown: str, page: Page) -> str: ' ```bash', f' uv add {package}', ' ```', - '=== "rye"', - ' ```bash', - f' rye add logfire {extras_arg}', - ' ```', '=== "poetry"', ' ```bash', f' poetry add {package}', diff --git a/mkdocs.yml b/mkdocs.yml index 1af094d4..69fabdc9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -67,10 +67,11 @@ extra_javascript: - "javascripts/algolia-search.js" nav: - - Logfire: + - Getting Started: - Logfire: index.md - Why Logfire?: why.md - Concepts: concepts.md + - Join Slack: help.md - Onboarding Checklist: - Onboarding Checklist: guides/onboarding-checklist/index.md - Integrate Logfire: guides/onboarding-checklist/integrate.md @@ -151,7 +152,6 @@ nav: - Propagate: reference/api/propagate.md - Exceptions: reference/api/exceptions.md - Pydantic: reference/api/pydantic.md - - Help: help.md - Roadmap: roadmap.md - Release Notes: release-notes.md