Skip to content

docs: canonical patterns for channelData, secret seeding, flow node kinds#32

Open
BimaPangestu28 wants to merge 2 commits into
mainfrom
docs/canonical-patterns
Open

docs: canonical patterns for channelData, secret seeding, flow node kinds#32
BimaPangestu28 wants to merge 2 commits into
mainfrom
docs/canonical-patterns

Conversation

@BimaPangestu28
Copy link
Copy Markdown
Member

Summary

Three new reference pages closing gaps surfaced by Maarten's R1 demo report and 3Point team's Q1-Q4.

Pages added

  • /reference/channel-data-access — DirectLine channelData access pattern, snake_case rename, auto-merge into WASM input. Closes Maarten's "how do we read r1_principals?" ask.
  • /reference/secret-seeding — URI scheme + Path A (setup.yaml wizard, preferred) + Path B (manual --pack-id admin set). Closes 3Point Q2 (api_key_secret).
  • /reference/flow-node-kinds — Five builtins shipping today (emit.response, emit.log, session.wait, flow.call, provider.invoke) + state-store gap section pointing at host-capability workaround. Closes 3Point Q4.

Why

3Point team's training-module deviation report and Maarten's R1 demo follow-up both pointed at platform docs gaps. These three pages document the canonical patterns that have been tribal knowledge until now.

Build

Astro build clean — 337 pages built. Sidebar updated in astro.config.mjs.

Translations

English source only. Translations will be regenerated via scripts/translate-docs.mjs after merge.

Related PRs

  • greentic-runner — extensions auto-merge implementation behind the channelData pattern.
  • greentic-secrets — --pack-id alias documented in secret-seeding page.
  • greentic-pack — builtin filter behind the flow-node-kinds page's emit.response notes.

Test plan

  • CI green (Astro build)
  • Reviewer skims three pages for accuracy / IA fit
  • Optional: trigger translation script post-merge

bundle-standard@0.2.0+ provides the same cards -> flow -> .gtpack
conversion inside a WASM sandbox via 'greentic-bundle ext render'.
The Greentic Designer now uses this embedded path internally.

The standalone greentic-cards2pack CLI remains fully supported for
direct use (CI pipelines, ad-hoc packaging, external integrations,
standalone authoring). Both paths share pure-Rust cards2pack-core
library and produce identical output.

Change is purely additive: one <Aside> note block above Installation
section. Original 270-line content preserved verbatim. Applied to
all 6 language variants (en + id/ja/zh/es/de).
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