Skip to content

Add Platform Data Flow explanation page#319

Open
lava wants to merge 4 commits into
mainfrom
claude/document-node-platform-data-gUBh5
Open

Add Platform Data Flow explanation page#319
lava wants to merge 4 commits into
mainfrom
claude/document-node-platform-data-gUBh5

Conversation

@lava
Copy link
Copy Markdown
Member

@lava lava commented May 13, 2026

Summary

Adds a new explanation page documenting how data flows between nodes and the platform, clarifying privacy boundaries and what information the platform can access.

Changes

  • New page: src/content/docs/explanations/platform/data-flow.mdx

    • Explains the WebSocket connection model (reverse tunnel, not a feed)
    • Documents what data the app pulls on demand (pipelines, metrics, diagnostics, contexts, packages, schemas)
    • Clarifies that pipeline data does not flow through the platform except for interactive queries
    • Describes secret resolution flow
    • Lists what is NOT sent to the platform
    • Discusses encryption, TLS termination, and trust boundaries
    • Includes cross-references to related guides and explanations
  • Updated sidebar: Added the new page to the explanations section under explanations/platform/data-flow in src/sidebar.ts

Implementation Details

The page uses semantic components (<Guide>, <Explanation>) for cross-references following documentation conventions. It provides clear, practical information about data privacy and compliance considerations for operators deploying nodes with the Tenzir platform.

https://claude.ai/code/session_01PKbEPqw2gThaw4TDoVzYCV

Adds an explanation page describing the node→platform WebSocket as a
reverse tunnel used by the app for on-demand API calls, clarifying that
pipeline data does not transit the platform except for live results
streamed from app-initiated pipelines.
@github-actions github-actions Bot added explanation Explanations site Site infrastructure labels May 13, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 13, 2026

📦 Preview  ·  View →  ·  🟢 Live

Verified for c41ca78  ·  Auto-updates on push

Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 298d07e0f6

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread src/content/docs/explanations/platform/data-flow.mdx Outdated
lava added 3 commits May 13, 2026 21:38
Per .agents/references/content.md, explanation pages must open with
"This page explains...". Rewrite the lead paragraph accordingly.
Per .agents/references/content.md, prefer <Explanation> over plain
markdown links when the link text matches the target page title.
Refer to the components by their full product names throughout the
page for consistency with the rest of the docs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

explanation Explanations site Site infrastructure

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant