Skip to content

Add write-ahead log documentation for Weave#2399

Merged
anastasiaguspan merged 14 commits into
mainfrom
weave-wal-docs-1993
Apr 21, 2026
Merged

Add write-ahead log documentation for Weave#2399
anastasiaguspan merged 14 commits into
mainfrom
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

mintlify Bot commented Mar 31, 2026

Copy link
Copy Markdown
Contributor

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

github-actions Bot commented Mar 31, 2026

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

github-actions Bot commented Mar 31, 2026

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: e679088 at 2026-04-21 13:56:34 UTC

@github-actions

github-actions Bot commented Mar 31, 2026

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

Adds `.cursor/` to `.gitignore` so local Cursor rules and editor config
stay untracked and out of PR diffs.

Each developer can keep personal rules (for example Jira MCP routing)
under `.cursor/rules` without committing them.

Made with [Cursor](https://cursor.com)

---------

Co-authored-by: Matt Linville <matt.linville@wandb.com>
@anastasiaguspan

Copy link
Copy Markdown
Contributor Author

{
"skill": "author-docs",
"version": "1.0.0",
"depends_on": {"style-guide": "1.0.0"},
"model": "unknown"
}

@anastasiaguspan anastasiaguspan added the author-docs-plugin Docs PRs authored via Cursor author-docs skill label Apr 20, 2026

@dbrian57 dbrian57 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving, but the intro needs a rewrite, and I've added a few other suggestions.

Comment thread support/weave/articles/trace-data-loss-in-worker-processes.mdx Outdated
Comment thread weave/guides/core-types/env-vars.mdx Outdated
Comment thread weave/guides/tracking/write-ahead-log.mdx Outdated
Comment thread weave/guides/tracking/write-ahead-log.mdx Outdated
Comment thread weave/guides/tracking/write-ahead-log.mdx Outdated
Comment thread weave/guides/tracking/write-ahead-log.mdx Outdated
Comment thread weave/guides/tracking/write-ahead-log.mdx Outdated
Comment thread weave/guides/tracking/write-ahead-log.mdx Outdated
Comment thread weave/guides/tracking/write-ahead-log.mdx Outdated
anastasiaguspan and others added 3 commits April 20, 2026 16:55
Co-authored-by: Dan Brian <dbrian@coreweave.com>
Co-authored-by: Dan Brian <dbrian@coreweave.com>
Co-authored-by: Dan Brian <dbrian@coreweave.com>
anastasiaguspan and others added 2 commits April 20, 2026 16:56
Co-authored-by: Dan Brian <dbrian@coreweave.com>
Co-authored-by: Dan Brian <dbrian@coreweave.com>
anastasiaguspan and others added 2 commits April 20, 2026 16:57
Co-authored-by: Dan Brian <dbrian@coreweave.com>
Co-authored-by: Dan Brian <dbrian@coreweave.com>
@anastasiaguspan anastasiaguspan force-pushed the weave-wal-docs-1993 branch 2 times, most recently from d25cc93 to d4fbbf3 Compare April 21, 2026 13:20
@anastasiaguspan anastasiaguspan marked this pull request as ready for review April 21, 2026 13:32
@anastasiaguspan anastasiaguspan requested a review from a team as a code owner April 21, 2026 13:32
@anastasiaguspan anastasiaguspan enabled auto-merge (squash) April 21, 2026 13:45
@anastasiaguspan anastasiaguspan merged commit 57c3de9 into main Apr 21, 2026
5 checks passed
@anastasiaguspan anastasiaguspan deleted the weave-wal-docs-1993 branch April 21, 2026 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author-docs-plugin Docs PRs authored via Cursor author-docs skill

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants