Open linear[bot] opened 4 months ago
For the POC on Python documentation within the Highlight.io codebase, focus on the following key areas and files:
Backend SDK Usage:
/docs-content/getting-started/4_backend-sdk/python/1_overview.md
.django.md
, flask.md
, fastapi.md
, which provide quick start components and setup instructions.Backend Tracing:
/docs-content/getting-started/6_backend-tracing/3_python/1_overview.md
.5_django.md
, 6_fastapi.md
, and 7_flask.md
.Backend Logging:
/docs-content/getting-started/5_backend-logging/03_python/1_overview.md
.loguru.md
and other.md
files within the same directory offer quick start guides for logging with Loguru and other setups.SDK Installation and Configuration:
/sdk/highlight-py/README.md
provides installation and configuration instructions for various Python frameworks.API Reference:
/docs-content/sdk/python.md
, including initialization and exception recording.Quickstart Guides for Frameworks:
/highlight.io/components/QuickstartContent/backend/python/
, offering step-by-step setup instructions.This structure ensures comprehensive coverage of Highlight.io's Python SDK capabilities, from basic setup to advanced features like tracing and logging. Each document and guide is tailored to specific Python frameworks, making it easier for developers to integrate Highlight.io into their projects.
highlight/highlight/docs-content/getting-started/4_backend-sdk/python highlight/highlight/docs-content/getting-started/6_backend-tracing/3_python highlight/highlight/docs-content/getting-started/5_backend-logging/03_python highlight/highlight/sdk/highlight-py/README.md highlight/highlight/docs-content/sdk/python.md highlight/highlight/highlight.io/components/QuickstartContent/backend/python/django.tsx highlight/highlight/highlight.io/components/QuickstartContent/backend/python/flask.tsx highlight/highlight/highlight.io/components/QuickstartContent/backend/python/fastapi.tsx highlight/highlight/highlight.io/components/QuickstartContent/backend/python/other.tsx highlight/highlight/highlight.io/components/QuickstartContent/logging/python/other.tsx
HIG-4621 POC: Python documentation