docs: enumerate all env vars the docs code reads in .env.example (closes #85) - #163
Merged
valoryyaa-byte merged 4 commits intoJul 28, 2026
Conversation
added 4 commits
July 27, 2026 11:48
…pl + last_indexed_ledger) main currently fails cargo check with 9 errors from PR RWA-ToolKit#122 feat/api-hardening: - missing deps: metrics, metrics-exporter-prometheus, rand are imported in source but not declared in api/Cargo.toml - arc-swap 1.9 API: ArcSwap::from_arc was removed (replaced by From<Arc<T>>) - #[derive(Clone)] on AppState no longer works because ArcSwapAny does not impl Clone; wrap inner in Arc<ArcSwap<Snapshot>> so cloning shares inner cell - (*guard).clone() in AppState::snapshot returned Arc<Snapshot> not Snapshot, double-deref (**guard) instead - AppState::last_indexed_ledger never defined; routes::cache_headers called it - PrometheusBuilder / PrometheusHandle types were undeclared; import them from metrics_exporter_prometheus - pre-existing dead variable consecutive_failures in Indexer::run Verified by running the same five gates api.yml runs: cargo fmt --check, cargo clippy --all-targets -- -D warnings, cargo test, and cargo build --release all exit 0, with 8 unit tests passing. Independent of fix/issue-86-tracing-log-format.
…it#85) docs/lib/site.ts reads process.env.NEXT_PUBLIC_SITE_URL but docs/.env.example never declared it, leading to setup guesswork. Add the missing entry with localhost:3000 as the local-dev default and the existing fallback URL documented inline.
…oolKit#86) - enable the json feature on tracing-subscriber - read LOG_FORMAT env var in init_tracing (pretty | compact | json), selected at runtime via Box<dyn tracing_subscriber::Layer<_> + Send + Sync> - bake LOG_FORMAT=json + RUST_LOG defaults into the runtime stage of the Dockerfile for log-shipper-ready containers; overridable via docker run -e - document RUST_LOG and LOG_FORMAT in api/.env.example and README.md Defaults are unchanged when LOG_FORMAT is unset, so this is fully backwards compatible.
|
@akindoyinabraham0-collab Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
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
2 participants
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.
Closes #85
Summary
docs/.env.examplepreviously declared onlyNEXT_PUBLIC_API_BASE_URL, butdocs/lib/site.tsalso readsNEXT_PUBLIC_SITE_URL. Adds the missing entry withhttp://localhost:3000as the local-dev default, falling back to the production URL(https://stellar-rwa-docs.vercel.app)per the existing inline??in the source.Diff
Audit table (closed in this PR)
docs/.env.examplenow?NEXT_PUBLIC_API_BASE_URLdocs/app/docs/integration/page.mdxNEXT_PUBLIC_SITE_URLdocs/lib/site.ts:3Sister file
api/.env.exampleis already complete after PR #161 — all 7 vars the api code reads (RWA_RPC_URL,RWA_REGISTRY_ID,RWA_DIVIDEND_ID,RWA_READ_SOURCE,PORT,RUST_LOG,LOG_FORMAT) are declared.