docs: v0.0.68 release notes, workflow output & StateStore docs, mock example naming - #18
Merged
Conversation
…mock example naming - v0.0.68 release notu (workflow output mapping, serbest payload, StateStoreTask type 17, transition history effective state, subflow fix seti) - Workflow bileşenine attributes.output alanı ve Output Mapping bölümü (TR+EN) - Yeni StateStore Task sayfası + task index/sidebar güncellemeleri (TR+EN) - REST API: serbest payload modu (x-vnext-payload-mode), sync output yanıtı, transition history yanıt alanları - Örneklerdeki gerçeğe yakın tanımlayıcılar mock isimlerle değiştirildi: on-burgan//onboarding → mock-app//sample-page, onboarding:kyc-main-flow → demo:sample-flow, architecture diyagramlarında Onboarding → Loan domain Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Reviewer's GuideThis PR adds v0.0.68 release documentation and updates REST/workflow/task/component docs to cover workflow output mapping, free-form payloads, StateStoreTask type 17, and transition history effective-state fields, while also replacing realistic onboarding examples with neutral mock/demo naming and wiring the new task into navigation. Sequence diagram for workflow output mapping on sync responsessequenceDiagram
actor Client
participant OrchestrationApi
participant WorkflowEngine
participant OutputScript
Client->>OrchestrationApi: POST /workflows/{wf}/instances/start?sync=true
OrchestrationApi->>WorkflowEngine: StartInstance
WorkflowEngine-->>WorkflowEngine: Load workflow.attributes.output
alt output mapping configured
WorkflowEngine->>OutputScript: IOutputHandler.Execute
alt script success
OutputScript-->>WorkflowEngine: body + statusCode + headers
WorkflowEngine-->>OrchestrationApi: mapped HTTP response
else script failure
OutputScript-->>WorkflowEngine: error
WorkflowEngine-->>OrchestrationApi: StartInstanceOutput
end
else no output mapping
WorkflowEngine-->>OrchestrationApi: StartInstanceOutput
end
OrchestrationApi-->>Client: HTTP response
Sequence diagram for StateStoreTask interactions with Dapr state storesequenceDiagram
participant WorkflowInstance
participant StateStoreTask
participant DaprStateStore
WorkflowInstance->>StateStoreTask: Execute TaskType 17 (command = set)
StateStoreTask-->>StateStoreTask: Prefix key with custom:
StateStoreTask->>DaprStateStore: SaveStateAsync(storeName, key, value, ttlInSeconds)
DaprStateStore-->>StateStoreTask: success + ETag
StateStoreTask-->>WorkflowInstance: Data + Metadata(ETag, Key)
WorkflowInstance->>StateStoreTask: Execute TaskType 17 (command = get)
StateStoreTask->>DaprStateStore: GetStateAndETagAsync(storeName, key)
DaprStateStore-->>StateStoreTask: value or null + ETag
StateStoreTask-->>WorkflowInstance: Data + Metadata(Found, ETag, Key)
Flow diagram for payload mode resolution on start/transitionflowchart TD
R[Request body + headers] --> H{x-vnext-payload-mode header}
H -->|raw| RAW[Mode = raw]
H -->|standard| STD[Mode = standard]
H -->|missing| M[Check top-level attributes key]
RAW --> N1[Normalize as free-form JSON]
STD --> N2[Bind as standard DTO]
M -->|attributes present| N2
M -->|attributes missing| N1
N1 --> O1["Wrap as { attributes: ... }"]
N2 --> O2[Use attributes as-is]
O1 --> B[Bind StartInstanceInput / TransitionInput]
O2 --> B
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
📝 WalkthroughWalkthroughThis PR adds v0.0.68 release documentation covering workflow output mapping, free-form JSON payloads, a new StateStore task type, and transition history snapshot fields, with corresponding REST API and component doc updates. It also renames example domain/flow identifiers (onboarding to loan/demo) across architecture diagrams and doc examples in both default and English i18n content trees. Changesv0.0.68 Feature Documentation
Estimated code review effort: 2 (Simple) | ~12 minutes Example domain/flow naming updates
Estimated code review effort: 1 (Trivial) | ~8 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- The new workflow
outputmapping behavior is now described in multiple places (REST API, workflow component, async/sync how-to); consider trimming these to a single authoritative section (e.g., workflow → Output Mapping) and referencing it elsewhere to avoid future divergence in edge-case behavior descriptions.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The new workflow `output` mapping behavior is now described in multiple places (REST API, workflow component, async/sync how-to); consider trimming these to a single authoritative section (e.g., workflow → Output Mapping) and referencing it elsewhere to avoid future divergence in edge-case behavior descriptions.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation to reflect the release of v0.0.68, which introduces workflow output mapping for synchronous responses, free-form payload support, a new StateStore task (Type 17) for Dapr state store caching, and effective state snapshots in transition history. It also replaces onboarding examples with loan or demo across several architecture and component documents. The review feedback highlights a translation discrepancy in the Related section of the State Store task documentation between the Turkish and English versions, suggesting that both Dapr Binding and Dapr PubSub tasks be referenced in both languages for consistency.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| ## İlgili | ||
|
|
||
| - [Tasks Genel Bakış](/docs/components/tasks/) — task türleri ve referans mekanizması | ||
| - [Dapr Binding Task](/docs/components/tasks/dapr-binding) — diğer Dapr tabanlı task türleri |
There was a problem hiding this comment.
Türkçe ve İngilizce dokümanlar arasında "İlgili" (Related) bölümündeki Dapr görev referanslarında tutarsızlık bulunuyor. Türkçe versiyonda Dapr Binding Task (dapr-binding) referans gösterilmişken, İngilizce versiyonda Dapr PubSub Task (dapr-pubsub) referans gösterilmiş. Her iki dilde de tutarlı olması için her iki görevi de listelemek daha faydalı olacaktır.
Suggested change
| - [Dapr Binding Task](/docs/components/tasks/dapr-binding) — diğer Dapr tabanlı task türleri | |
| - [Dapr Binding Task](/docs/components/tasks/dapr-binding) — diğer Dapr tabanlı task türleri | |
| - [Dapr PubSub Task](/docs/components/tasks/dapr-pubsub) — diğer Dapr tabanlı task türleri |
| ## Related | ||
|
|
||
| - [Tasks Overview](/docs/components/tasks/) — task types and the reference mechanism | ||
| - [Dapr PubSub Task](/docs/components/tasks/dapr-pubsub) — other Dapr-based task types |
There was a problem hiding this comment.
Türkçe ve İngilizce dokümanlar arasında "İlgili" (Related) bölümündeki Dapr görev referanslarında tutarsızlık bulunuyor. İngilizce versiyonda Dapr PubSub Task (dapr-pubsub) referans gösterilmişken, Türkçe versiyonda Dapr Binding Task (dapr-binding) referans gösterilmiş. Her iki dilde de tutarlı olması için her iki görevi de listelemek daha faydalı olacaktır.
Suggested change
| - [Dapr PubSub Task](/docs/components/tasks/dapr-pubsub) — other Dapr-based task types | |
| - [Dapr Binding Task](/docs/components/tasks/dapr-binding) — other Dapr-based task types | |
| - [Dapr PubSub Task](/docs/components/tasks/dapr-pubsub) — other Dapr-based task types |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@blog/2026-07-02-v0-0-68.md`:
- Around line 104-106: The markdown fence for the API route example is missing
an explicit language, causing the MD040 lint issue. Update the fenced block in
the release note snippet to use a clear language tag such as http or text,
keeping the endpoint example itself unchanged and making sure the surrounding
markdown in the document stays valid.
In `@docs/components/tasks/state-store.md`:
- Around line 1-5: Add the missing documentation frontmatter fields for the
State Store page by updating the existing frontmatter block in state-store.md to
include both id and sidebar_label alongside title; keep the current content
intact and ensure the values are consistent with the page’s purpose so it
satisfies the repo’s docs guideline for markdown pages.
In
`@i18n/en/docusaurus-plugin-content-docs/current/components/tasks/state-store.md`:
- Around line 1-5: The frontmatter for the State Store Task page is missing the
mirrored metadata required for translated docs. Update the frontmatter in the
State Store doc to include the original Turkish page’s id and slug, and add
sidebar_label alongside the existing title so it matches the docs metadata
contract. Keep the change in the frontmatter block for the State Store task
document.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 8501ee75-fcff-44b8-8cfb-d609003c5ceb
📒 Files selected for processing (22)
architecture/data/database.mdarchitecture/domain-model/index.mdarchitecture/domain-model/topology.mdarchitecture/overview/index.mdblog/2026-05-19-v0-0-54-duyuru.mdblog/2026-07-02-v0-0-68.mddocs/api-reference/rest-api.mddocs/components/tasks/index.mddocs/components/tasks/state-store.mddocs/components/urn-catalog.mddocs/components/view.mddocs/components/workflow.mddocs/how-to/async-sync.mddocs/how-to/view-consept/aksiyonlar.mddocs/tools/workflow-cli.mdi18n/en/docusaurus-plugin-content-docs-architecture/current/data/database.mdi18n/en/docusaurus-plugin-content-docs-architecture/current/domain-model/topology.mdi18n/en/docusaurus-plugin-content-docs/current/components/tasks/index.mdi18n/en/docusaurus-plugin-content-docs/current/components/tasks/state-store.mdi18n/en/docusaurus-plugin-content-docs/current/components/urn-catalog.mdi18n/en/docusaurus-plugin-content-docs/current/components/workflow.mdsidebars.ts
Comment on lines
+104
to
+106
| ``` | ||
| GET /api/v1/{domain}/workflows/{workflow}/instances/{instance}/transitions | ||
| ``` |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Specify a fence language.
The bare fence here triggers MD040 and makes the markdown lint output noisy. Use an explicit language such as http or text.
🛠️ Proposed fix
-```
+```http
GET /api/v1/{domain}/workflows/{workflow}/instances/{instance}/transitions
-```
+```📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| ``` | |
| GET /api/v1/{domain}/workflows/{workflow}/instances/{instance}/transitions | |
| ``` |
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 104-104: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@blog/2026-07-02-v0-0-68.md` around lines 104 - 106, The markdown fence for
the API route example is missing an explicit language, causing the MD040 lint
issue. Update the fenced block in the release note snippet to use a clear
language tag such as http or text, keeping the endpoint example itself unchanged
and making sure the surrounding markdown in the document stays valid.
Source: Linters/SAST tools
Comment on lines
+1
to
+5
| --- | ||
| sidebar_position: 13 | ||
| title: State Store Task | ||
| description: Dapr state store üzerinden cache okuma/yazma/silme yapan task | ||
| --- |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟠 Major | ⚡ Quick win
Add the required frontmatter fields.
This page is missing id and sidebar_label, which are required by the repo's documentation guidelines.
As per coding guidelines, **/{docs,architecture,business,product}/**/*.{md,mdx}: Every documentation page must include frontmatter with at minimum: id, title, and sidebar_label fields.
🛠️ Proposed fix
---
+id: state-store
sidebar_position: 13
title: State Store Task
+sidebar_label: State Store Task
description: Dapr state store üzerinden cache okuma/yazma/silme yapan task
---📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| --- | |
| sidebar_position: 13 | |
| title: State Store Task | |
| description: Dapr state store üzerinden cache okuma/yazma/silme yapan task | |
| --- | |
| --- | |
| id: state-store | |
| sidebar_position: 13 | |
| title: State Store Task | |
| sidebar_label: State Store Task | |
| description: Dapr state store üzerinden cache okuma/yazma/silme yapan task | |
| --- |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/components/tasks/state-store.md` around lines 1 - 5, Add the missing
documentation frontmatter fields for the State Store page by updating the
existing frontmatter block in state-store.md to include both id and
sidebar_label alongside title; keep the current content intact and ensure the
values are consistent with the page’s purpose so it satisfies the repo’s docs
guideline for markdown pages.
Source: Coding guidelines
Comment on lines
+1
to
+5
| --- | ||
| sidebar_position: 13 | ||
| title: State Store Task | ||
| description: Task that reads, writes, and deletes cache entries via a Dapr state store | ||
| --- |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Add the missing mirror frontmatter fields.
This page still needs id and sidebar_label, so it doesn't satisfy the docs metadata contract for mirrored pages yet. As per coding guidelines, every documentation page must include frontmatter with at minimum id, title, and sidebar_label fields, and English translations must preserve the original Turkish id and slug.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In
`@i18n/en/docusaurus-plugin-content-docs/current/components/tasks/state-store.md`
around lines 1 - 5, The frontmatter for the State Store Task page is missing the
mirrored metadata required for translated docs. Update the frontmatter in the
State Store doc to include the original Turkish page’s id and slug, and add
sidebar_label alongside the existing title so it matches the docs metadata
contract. Keep the change in the frontmatter block for the State Store task
document.
Source: Coding guidelines
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
1 participant
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.
Özet
v0.0.68 (vnext milestone 34) release notu eklendi ve yeni özelliklerin (workflow
outputmapping, serbest payload, StateStoreTask type 17, transition history effective state alanları) bileşen/API dokümanları güncellendi. Ayrıca örneklerdeki gerçeğe yakın tanımlayıcılar (on-burgan//onboardingdeeplink'i,onboarding:kyc-main-flowURN'leri, architecture diyagramlarındaki Onboarding domain) güvenlik gerekçesiyle mock isimlerle değiştirildi (mock-app//sample-page,demo:sample-flow, Loan domain).Etkilenen Bölüm
docs/)architecture/)business/)product/)blog/)sidebars.ts)Dil
Local Doğrulama
npm run buildbaşarılı (tr + en)npm run startile gözle kontrol edildi (build çıktısındaki HTML üzerinden doğrulandı: yeni sayfalar üretildi, mock isimler yerinde, eski ifadeler kalmadı)İlgili Phase / Issue
Reviewer Notları
schemaVersion: 0.0.49yazıyor — yayınlanan@burgan-tech/vnext-schema@0.0.49paketi workflowoutputve task type"17"tanımlarını içeriyor (unpkg üzerinden doğrulandı).business/veproduct/altındaki kavramsal "onboarding" kullanımları (self-service onboarding, müşteri onboarding süreci vb.) bilinçli olarak korundu — bir sisteme değil genel kavrama işaret ediyorlar.2026-05-19-v0-0-54-duyuru.mdiçindeki"stage": "onboarding"örnek değeri"application-review"olarak güncellendi.🤖 Generated with Claude Code
Summary by CodeRabbit
New Features
Bug Fixes
Documentation