Skip to content

docs: add comprehensive LF-format documentation#11

Merged
deborahjacob-botanu merged 2 commits intomainfrom
developer-deborah
Feb 6, 2026
Merged

docs: add comprehensive LF-format documentation#11
deborahjacob-botanu merged 2 commits intomainfrom
developer-deborah

Conversation

@deborahjacob-botanu
Copy link
Copy Markdown
Collaborator

Add complete documentation structure following Linux Foundation format:

Getting Started:

  • installation.md - Package installation and extras
  • quickstart.md - 5-minute guide to cost attribution
  • configuration.md - Environment variables and YAML config

Concepts:

  • architecture.md - Thin SDK / smart collector design
  • run-context.md - Run model and UUIDv7 generation
  • context-propagation.md - W3C Baggage propagation

Tracking:

  • llm-tracking.md - LLM/GenAI tracking with OTel semconv
  • data-tracking.md - Database, storage, messaging tracking
  • outcomes.md - Business outcome recording

Integration:

  • auto-instrumentation.md - Automatic library instrumentation
  • existing-otel.md - Integration with existing OTel setups
  • collector.md - OTel Collector configuration for cost calc

Patterns:

  • best-practices.md - Recommended patterns
  • anti-patterns.md - Common mistakes to avoid

API Reference:

  • decorators.md - @botanu_use_case, @botanu_outcome
  • tracking.md - Tracking context managers and helpers
  • configuration.md - BotanuConfig and enable() API

Summary

Changes

Type of change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update
  • CI / build / tooling

Testing

  • Unit tests pass (pytest)
  • Lint passes (ruff check)
  • Type check passes (mypy)

Checklist

  • My code follows the project's coding style
  • I have added SPDX headers to new files
  • I have added tests for my changes
  • I have updated documentation if needed
  • All commits are signed off (git commit -s) per the DCO

deborahjacob-botanu and others added 2 commits February 5, 2026 18:53
Add complete documentation structure following Linux Foundation format:

Getting Started:
- installation.md - Package installation and extras
- quickstart.md - 5-minute guide to cost attribution
- configuration.md - Environment variables and YAML config

Concepts:
- architecture.md - Thin SDK / smart collector design
- run-context.md - Run model and UUIDv7 generation
- context-propagation.md - W3C Baggage propagation

Tracking:
- llm-tracking.md - LLM/GenAI tracking with OTel semconv
- data-tracking.md - Database, storage, messaging tracking
- outcomes.md - Business outcome recording

Integration:
- auto-instrumentation.md - Automatic library instrumentation
- existing-otel.md - Integration with existing OTel setups
- collector.md - OTel Collector configuration for cost calc

Patterns:
- best-practices.md - Recommended patterns
- anti-patterns.md - Common mistakes to avoid

API Reference:
- decorators.md - @botanu_use_case, @botanu_outcome
- tracking.md - Tracking context managers and helpers
- configuration.md - BotanuConfig and enable() API

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Signed-off-by: Deborah Jacob <deborah@botanu.ai>
Release preparation for TestPyPI and PyPI publishing:

- Update release.yml workflow:
  - Add TestPyPI support with manual trigger
  - Add twine check validation
  - Pre-release tags (alpha/beta/rc) go to TestPyPI
  - Release tags go to PyPI
  - Uses Trusted Publishing (OIDC) - no API tokens needed

- Update CHANGELOG.md:
  - Add v0.1.0 release notes
  - Document all features, extras, and dependencies

- Enhance README.md:
  - Add Python versions badge
  - Add installation extras table
  - Add LLM and data tracking examples
  - Add architecture diagram
  - Add documentation links

- Add RELEASE.md:
  - Document release workflow
  - Trusted Publishing setup instructions
  - TestPyPI verification steps
  - Local build verification
  - Rollback procedures
  - Release checklist

Build verified locally:
- python -m build: PASSED
- twine check dist/*: PASSED
- Wheel contents verified

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Signed-off-by: Deborah Jacob <deborah@botanu.ai>
@deborahjacob-botanu deborahjacob-botanu merged commit 3fb662c into main Feb 6, 2026
18 of 20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant