Skip to content

docs: make sure docs are in sync with latest changes#52

Merged
Azhovan merged 1 commit intomainfrom
docs/improve-docs
Mar 8, 2026
Merged

docs: make sure docs are in sync with latest changes#52
Azhovan merged 1 commit intomainfrom
docs/improve-docs

Conversation

@Azhovan
Copy link
Owner

@Azhovan Azhovan commented Mar 8, 2026

What

  • Align docs with current behavior for derived snake_case keys and env: matching after sourceenv prefix stripping.
  • Update contributor docs to match the current Makefile commands and coverage gate.
  • Fix examples/basic docs/config to use the current snake_case keys and working env var names.

Why

The docs and checked-in basic example had drifted from the implementation and were giving incorrect setup/binding guidance.

Type

  • Fix
  • Feature
  • Docs
  • Performance
  • Breaking change

Testing

Executed:

  • go run ./examples/transformer
  • env GOCACHE=/tmp/rigging-gocache GOTMPDIR=/tmp go run ./examples/basic
  • env GOCACHE=/tmp/rigging-gocache GOTMPDIR=/tmp APP_ENVIRONMENT=production APP_DATABASE__HOST=prod-db.example.com APP_DATABASE__SSL_MODE=require go run ./examples/basic
  • env GOCACHE=/tmp/rigging-gocache GOTMPDIR=/tmp APP_FEATURES__ENABLE_METRICS=true APP_FEATURES__RATE_LIMIT=5000 go run ./examples/basic

Would run:

  • go test ./...
go run ./examples/transformer
env GOCACHE=/tmp/rigging-gocache GOTMPDIR=/tmp go run ./examples/basic
env GOCACHE=/tmp/rigging-gocache GOTMPDIR=/tmp APP_ENVIRONMENT=production APP_DATABASE__HOST=prod-db.example.com APP_DATABASE__SSL_MODE=require go run ./examples/basic
env GOCACHE=/tmp/rigging-gocache GOTMPDIR=/tmp APP_FEATURES__ENABLE_METRICS=true APP_FEATURES__RATE_LIMIT=5000 go run ./examples/basic

@Azhovan Azhovan self-assigned this Mar 8, 2026
@Azhovan Azhovan requested a review from asadijabar March 8, 2026 11:05
@Azhovan Azhovan merged commit ad8866f into main Mar 8, 2026
5 checks passed
@github-actions github-actions bot deleted the docs/improve-docs branch March 8, 2026 11:06
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.

2 participants