Skip to content

Add write-ahead log documentation for Weave#2399

Draft
anastasiaguspan wants to merge 1 commit intomainfrom
weave-wal-docs-1993
Draft

Add write-ahead log documentation for Weave#2399
anastasiaguspan wants to merge 1 commit intomainfrom
weave-wal-docs-1993

Conversation

@anastasiaguspan
Copy link
Copy Markdown
Contributor

Summary

  • Add new documentation page for the Weave write-ahead log (WAL) feature (weave/guides/tracking/write-ahead-log.mdx), covering what the WAL is, how to enable it, how it works, and when to use it.
  • Add WEAVE_ENABLE_WAL and WEAVE_DISABLE_WAL_SENDER to the environment variables reference page.
  • Add cross-reference from the "Trace data loss in worker processes" support article to the new WAL page.
  • Add the new page to the "Advanced Ops" navigation group in docs.json.

Sources and decision log

  • Primary source: Loom demo by the feature author, walking through the WAL feature end-to-end.
  • Document type: Concept explainer with how-to elements (Diataxis hybrid). The WAL is a feature users enable rather than a multi-step workflow, so a concept-focused page with a short enablement section fits better than a pure how-to guide.
  • Placement: Added to the "Advanced Ops" group under "Trace your application" because it is an advanced tracing configuration, similar to trace-disable and ops.
  • Cross-references: Linked from the existing support article on trace data loss, since the WAL directly addresses that problem. Also linked from the env-vars reference page.
  • Known gaps: The WAL is opt-in and shipping in the next client release. The page notes it will be enabled by default in a future release. This note should be removed when that happens.

Test plan

  • mintlify broken-links passes with no broken links.
  • Verify page renders correctly in Mintlify preview.
  • SME review for technical accuracy of the "How it works" section.
  • Confirm env var names match the implementation (WEAVE_ENABLE_WAL, WEAVE_DISABLE_WAL_SENDER).

Made with Cursor

Document the new opt-in write-ahead log (WAL) feature that persists
trace data to disk before sending it to the server, improving
resilience against data loss from crashes, OOM kills, or server
unavailability.

Made-with: Cursor
@mintlify
Copy link
Copy Markdown
Contributor

mintlify bot commented Mar 31, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
wandb 🟢 Ready View Preview Mar 31, 2026, 3:25 PM

@anastasiaguspan
Copy link
Copy Markdown
Contributor Author

Resume prompt

To pick up where this session left off, use the following prompt:

PR #2399 adds documentation for the Weave write-ahead log (WAL) feature on branch weave-wal-docs-1993. The new page is at weave/guides/tracking/write-ahead-log.mdx. It also updates weave/guides/core-types/env-vars.mdx (added two new env vars), docs.json (navigation), and support/weave/articles/trace-data-loss-in-worker-processes.mdx (cross-reference). The page is based on a Loom demo. Key decisions: placed in the "Advanced Ops" nav group, concept-explainer format, opt-in note that should be removed when WAL becomes the default. Needs SME review for technical accuracy and a Mintlify preview check.

@github-actions
Copy link
Copy Markdown
Contributor

Knowledgebase navigation update

No updates to support articles, tag pages, product indexes or docs.json from this run.

@github-actions
Copy link
Copy Markdown
Contributor

📚 Mintlify Preview Links

🔗 View Full Preview

✨ Added (1 total)

📄 Pages (1)

File Preview
weave/guides/tracking/write-ahead-log.mdx Write Ahead Log

📝 Changed (3 total)

📄 Pages (2)

File Preview
support/weave/articles/trace-data-loss-in-worker-processes.mdx Trace Data Loss In Worker Processes
weave/guides/core-types/env-vars.mdx Env Vars
⚙️ Other (1)
File
docs.json

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: cdf1cad at 2026-03-31 15:26:05 UTC

@github-actions
Copy link
Copy Markdown
Contributor

🔗 Link Checker Results

All links are valid!

No broken links were detected.

Checked against: https://wb-21fd5541-weave-wal-docs-1993.mintlify.app

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.

1 participant