search

highlight / highlight

highlight.io: The open source, full-stack monitoring platform. Error monitoring, session replay, logging, distributed tracing, and more.
https://app.highlight.io
Other
7.42k stars 344 forks source link

POC: Python documentation #8479

Open linear[bot] opened 4 months ago

linear[bot] commented 4 months ago

HIG-4621 POC: Python documentation

greptile-apps[bot] commented 4 months ago

For the POC on Python documentation within the Highlight.io codebase, focus on the following key areas and files:

  1. Backend SDK Usage:

    • Overview and setup instructions are detailed in /docs-content/getting-started/4_backend-sdk/python/1_overview.md.
    • Framework-specific guides are found in the same directory, e.g., django.md, flask.md, fastapi.md, which provide quick start components and setup instructions.

  2. Backend Tracing:

    • An overview of tracing in Python is provided in /docs-content/getting-started/6_backend-tracing/3_python/1_overview.md.
    • Framework-specific tracing instructions, such as for Django, Flask, and FastAPI, are detailed in files like 5_django.md, 6_fastapi.md, and 7_flask.md.

  3. Backend Logging:

    • The logging overview and setup instructions are in /docs-content/getting-started/5_backend-logging/03_python/1_overview.md.
    • The loguru.md and other.md files within the same directory offer quick start guides for logging with Loguru and other setups.

  4. SDK Installation and Configuration:

    • The SDK README at /sdk/highlight-py/README.md provides installation and configuration instructions for various Python frameworks.

  5. API Reference:

    • Detailed SDK API usage is documented in /docs-content/sdk/python.md, including initialization and exception recording.

  6. Quickstart Guides for Frameworks:

    • Quickstart content for Django, Flask, FastAPI, and other Python frameworks is provided in TypeScript files within /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.

References

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

Ask Greptile