docs: add comprehensive LF-format documentation#11
Merged
deborahjacob-botanu merged 2 commits intomainfrom Feb 6, 2026
Merged
Conversation
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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add complete documentation structure following Linux Foundation format:
Getting Started:
Concepts:
Tracking:
Integration:
Patterns:
API Reference:
Summary
Changes
Type of change
Testing
pytest)ruff check)mypy)Checklist
git commit -s) per the DCO