Skip to content

docs(config): add comprehensive environment configuration documentation matrix (#693) - #745

Open
ravendevhub wants to merge 1 commit into
Core-Foundry:mainfrom
ravendevhub:docs/environment-config-matrix-693
Open

docs(config): add comprehensive environment configuration documentation matrix (#693)#745
ravendevhub wants to merge 1 commit into
Core-Foundry:mainfrom
ravendevhub:docs/environment-config-matrix-693

Conversation

@ravendevhub

Copy link
Copy Markdown

Summary

Resolves #693 by establishing a comprehensive reference matrix in docs/ENVIRONMENT_CONFIGURATION_MATRIX.md detailing all 22 environment variables, data types, required/optional status, default values, applicable environments, and sensitive secret classifications across NotifyChain.

Changes

  1. Environment Configuration Matrix (docs/ENVIRONMENT_CONFIGURATION_MATRIX.md):
    • Covers core variables across network, contract bindings, authentication, logging, retries, and persistence.
    • Categorizes variable sensitivity (🔒 Sensitive vs 🌐 Public).
    • Details safe default fallbacks for local development and testnet.
  2. Security & Redaction Guidelines:
    • Defines strict policies forbidding secret emission in diagnostics and build artifacts.

Acceptance Criteria

  • Every supported environment variable is documented.
  • Required and optional values are clearly distinguished.
  • Defaults are documented where applicable.
  • Sensitive values are clearly identified without exposing actual secrets.

…on matrix (Core-Foundry#693)

- Document all 22 supported environment variables across listener, dashboard, and deployer
- Distinguish required vs optional status and explicit data types
- Document deterministic default values for local and testnet execution
- Clearly identify sensitive secrets without exposing actual credentials
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.

Add Environment Configuration Documentation Matrix

1 participant