Skip to content

Comments

docs: Add configuration injection guide#472

Merged
mikelane merged 2 commits intomainfrom
issue-348-config-docs
Feb 7, 2026
Merged

docs: Add configuration injection guide#472
mikelane merged 2 commits intomainfrom
issue-348-config-docs

Conversation

@mikelane
Copy link
Owner

@mikelane mikelane commented Feb 7, 2026

Summary

  • Add docs/guides/configuration.md covering config injection patterns: Pydantic Settings integration, multiple config classes, testing with register_instance(), environment-specific config, startup validation, and common mistakes
  • Add register_instance() API reference section within the guide
  • Update README "Common Patterns" section to use the preferred @service config pattern instead of the older ConfigPort adapter pattern
  • Add configuration guide to the docs toctree under Advanced Topics

Test plan

  • Sphinx build succeeds with no new warnings
  • All code examples use current dioxide API (Container(profile=...), @service, register_instance())
  • No references to deprecated patterns (container.scan() without profile keyword)
  • Verify links resolve on ReadTheDocs after deploy

Fixes #348

Generated with Claude Code

@codecov
Copy link

codecov bot commented Feb 7, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.85%. Comparing base (9f37e0b) to head (3d70057).
⚠️ Report is 7 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #472   +/-   ##
=======================================
  Coverage   91.85%   91.85%           
=======================================
  Files          21       21           
  Lines        1903     1903           
  Branches      372      372           
=======================================
  Hits         1748     1748           
  Misses         91       91           
  Partials       64       64           
Flag Coverage Δ
python-3.13 91.85% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted file tree graph

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@mikelane mikelane merged commit 5701ea2 into main Feb 7, 2026
21 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.

Config Injection: Documentation and Examples

1 participant