Skip to content

[docs] docs: add AWF_ONE_SHOT_TOKEN_DEBUG documentation#867

Merged
Mossaka merged 1 commit intomainfrom
docs/one-shot-token-debug-env-var-d53a857aee357604
Feb 17, 2026
Merged

[docs] docs: add AWF_ONE_SHOT_TOKEN_DEBUG documentation#867
Mossaka merged 1 commit intomainfrom
docs/one-shot-token-debug-env-var-d53a857aee357604

Conversation

@github-actions
Copy link
Contributor

Documentation Sync - Feb 9-16, 2026

This PR synchronizes documentation with code changes from the past 7 days.

Changes Made

  • Updated docs/environment.md: Added "Debugging Environment Variables" section documenting the AWF_ONE_SHOT_TOKEN_DEBUG environment variable with usage examples and behavior description
  • Updated docs/troubleshooting.md: Added "Token Caching Issues" section with troubleshooting steps for one-shot-token library debug logging

Code Changes Referenced

  • Commit 2d90521: feat: add AWF_ONE_SHOT_TOKEN_DEBUG env var for silent-by-default logging (feat: add AWF_ONE_SHOT_TOKEN_DEBUG env var for silent-by-default logging #864)
    • Added AWF_ONE_SHOT_TOKEN_DEBUG environment variable to control debug logging in both C and Rust implementations
    • Updated containers/agent/one-shot-token/README.md with comprehensive documentation
    • Created docs/environment.md (but did not include the debug variable)

Documentation Gap

The recent commit added the AWF_ONE_SHOT_TOKEN_DEBUG feature and documented it in the one-shot-token library's README, but did not add it to user-facing documentation:

  1. docs/environment.md - Has an "Internal Environment Variables" section but was missing the debugging variable
  2. docs/troubleshooting.md - Has debugging guidance but no mention of one-shot-token debugging

This PR fills those gaps by adding the new environment variable to user-facing documentation with practical examples.

Verification

  • Code examples verified against actual implementation
  • Consistent with existing documentation style
  • References correct file paths (containers/agent/one-shot-token/README.md)
  • Follows AWF documentation conventions

AI generated by Documentation Maintainer

Document the AWF_ONE_SHOT_TOKEN_DEBUG environment variable in user-facing
documentation to help users troubleshoot token caching issues.

Changes:
- docs/environment.md: Add Debugging Environment Variables section with
  AWF_ONE_SHOT_TOKEN_DEBUG documentation and usage examples
- docs/troubleshooting.md: Add Token Caching Issues section with
  troubleshooting steps for one-shot-token library

Related to commit 2d90521 which added the AWF_ONE_SHOT_TOKEN_DEBUG feature
to both C and Rust implementations of the one-shot-token library.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-generated documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants