Skip to content

docs: Forge-first onboarding, Forge & Quick Runner guides, v0.0.79 transition semantics - #23

Merged
yilmaztayfun merged 1 commit into
mainfrom
f/v0-0-79-docs
Aug 12, 2026
Merged

docs: Forge-first onboarding, Forge & Quick Runner guides, v0.0.79 transition semantics#23
yilmaztayfun merged 1 commit into
mainfrom
f/v0-0-79-docs

Conversation

@yilmaztayfun

@yilmaztayfun yilmaztayfun commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Özet

Getting Started akışı Forge merkezli hale getirildi (eski local-dev/multi-domain rehberleri arşivlendi), Forge kullanımı ve Flow Quick Runner için gerçek ekran görüntülü detaylı kılavuzlar eklendi; v0.0.79 için updateData/lock yürütme semantiği (#877) ve tracing (#874) dokümante edildi.

Değişiklikler

Getting Started yeniden yapılandırması

  • local-dev ve multi-domain rehberleri docs/archive/ altına taşındı (deprecation banner + sidebar'da daraltılmış Arşiv kategorisi); manuel docker-compose kurulumu yalnızca referans olarak duruyor.
  • Yeni Geliştirme Ortamı Kurulumu (Forge) sayfası (getting-started/forge-setup): extension kurulumu → opsiyonel AI plugin → proje oluşturma (AI vnext-init / Forge Create Project) → CLI otomatik kurulum + manuel fallback → Local/Remote environment ekleme → flow geliştirme; Forge–CLI–Runtime ilişkisi ve sorun giderme repo haritası.

Yeni araç kılavuzları

  • Forge Kullanım Kılavuzu (tools/forge-usage): Forge Tools panelleri (Settings/Project/Environments/Package Deploy/Quick Run), Explorer sağ-tık menüleri, 7 component tasarımcısı (metadata + scroll'lu configuration ekranları), Publish→CLI eşlemesi (wf update, --all, csx --all).
  • Flow Quick Runner (tools/quick-runner): kırmızı çerçeveli 14 numaralı bölgeyle işaretlenmiş ana ekran, Start Instance, Fire Transition (şema tabanlı form + Generate), pseudo-ui State View render davranışı, Data/History/Correlations/Raw, Instance Details modalı, long-poll, Function Quick Runner (get-branches-func).
  • 40+ ekran görüntüsü canlı ortamda (vnext-example + Local core environment, money-transfer akışı) VS Code'dan alındı — static/img/tools/forge/.

v0.0.79 içerik güncellemeleri

  • workflow.md (tr+en): yeni Transition Yürütme Modeli bölümü — Busy-as-mutex, kabul matrisi (state/shared: lock+busy check; cancel/exit: busy check muaf; updateData: koşulsuz), reserve updateData semantiği (status-neutral, subflow'da parent'ta karşılanır ve forward edilmez, auto'lar her updateData sonrası order 90'da değerlendirilir) ve flow tasarım notları (vnext #877).
  • Release notes: #877 ve #874 (business tracing, Aether 1.0.34) bölümleri; Overview/Behavior Changes/Issues/Summary güncellendi.
  • Breaking changes: #877 için 8–10. maddeler (chain-token → Busy-as-mutex, updateData semantiği, InstanceData anlık kalıcılık / HistorySequence kaldırımı).
  • Release tarihi 2026-08-13'e alındı (dosya adları + frontmatter + footer).

Etkilenen Bölüm

  • Technical (docs/)
  • Architecture (architecture/)
  • Business (business/)
  • Product (product/)
  • Blog (blog/)
  • Tooling / CI / Config

Dil

  • TR yazıldı
  • EN çevirisi eklendi

Local Doğrulama

  • npm run build başarılı (her iki locale)
  • npm run start ile gözle kontrol edildi
  • Internal linkler kırık değil (kalan anchor uyarıları yalnızca EN locale'de önceden var olan türden)

İlgili Phase / Issue

  • vnext #877 — Busy-as-mutex, status-neutral updateData
  • vnext #874 — business-focused workflow tracing

Not: #877 bu PR yazılırken henüz OPEN görünüyordu; release yayınlanmadan merge edildiği teyit edilmeli.

🤖 Generated with Claude Code

Summary by Sourcery

Rework docs to make Forge-based development the primary onboarding path, add detailed guides for Forge usage and Flow Quick Runner, and document the v0.0.79 Busy-as-mutex transition execution model and tracing changes in both release notes and workflow component docs.

New Features:

  • Introduce Forge-centric development environment setup guides in Turkish and English, covering project creation, Workflow CLI installation, and local/remote environment management.
  • Add comprehensive Forge Usage Guide documentation describing Tools panels, Explorer context menus, component designers, and the publish–CLI relationship.
  • Add Flow Quick Runner documentation for starting instances, firing transitions, inspecting state views, and testing functions against live environments.

Enhancements:

  • Update Getting Started, intro, tools, and Forge Studio docs to point to the new Forge-based setup and usage guides instead of manual local-dev/multi-domain flows.
  • Archive the legacy local-dev and multi-domain setup guides under a new Archive section with deprecation warnings in both locales.
  • Extend workflow component documentation (TR/EN) with a Transition Execution Model section explaining Busy-as-mutex locking, status-neutral updateData semantics, and immediate InstanceData persistence, and adjust updateData descriptions accordingly.
  • Expand v0.0.79 release and breaking-changes blog posts with Busy-as-mutex locking, updateData behavior changes, InstanceData write model, business-focused tracing taxonomy, and move the release date/tags to August 13, 2026.

Documentation:

  • Document Busy-as-mutex locking, status-neutral updateData, and InstanceData persistence semantics for v0.0.79 in workflow component docs and release/breaking-changes notes.
  • Provide new user-facing documentation for Forge Tools usage and Flow Quick Runner, including screenshots and bilingual content for TR and EN locales.

Summary by CodeRabbit

  • New Features
    • Added Busy-as-mutex transition execution to prevent conflicting requests with clear conflict responses.
    • Added immediate workflow data persistence and business-focused tracing.
    • Introduced Forge setup, usage, and Quick Runner documentation.
  • Breaking Changes
    • updateData is now status-neutral and restarts retry processing from the beginning.
    • Updated concurrency, subflow, persistence, and transition behavior.
  • Documentation
    • Added Forge development guidance and expanded workflow documentation.
    • Archived legacy setup guides and linked to their Forge-based replacements.
    • Updated navigation, tutorials, and v0.0.79 release information.

… updateData/lock semantics for v0.0.79

- Archive local-dev and multi-domain guides (tr+en) under docs/archive with
  deprecation banners; manual docker-compose setup stays as reference only
- Add Forge-based development environment setup guide (forge-setup): extension
  install, AI plugin, project creation (AI init / Create Project), automatic
  Workflow CLI install with manual fallback, local & remote environments,
  troubleshooting repo map
- Add Forge usage guide (forge-usage): Forge Tools panels, explorer context
  menus, all component designers with metadata + configuration screenshots,
  publish-to-CLI mapping (wf update / --all / csx --all)
- Add Flow Quick Runner guide (quick-runner): annotated main screen (14 numbered
  regions), start instance, fire transition, pseudo-ui state view rendering,
  Data/History/Correlations/Raw tabs, instance details modal, long-poll
  behavior, Function Quick Runner with get-branches-func
- 40+ real screenshots captured from VS Code with the live extension under
  static/img/tools/forge/
- Document v0.0.79 transition execution model in workflow.md (tr+en):
  Busy-as-mutex, admission matrix (state/shared vs cancel/exit vs updateData),
  status-neutral reserve updateData semantics incl. subflow parent handling
- Extend v0.0.79 release notes with #877 (Busy-as-mutex, updateData v2,
  immediate InstanceData persistence) and #874 (business-focused tracing,
  Aether 1.0.34); add breaking-changes items 8-10; move release date to
  2026-08-13

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@yilmaztayfun
yilmaztayfun requested a review from a team August 12, 2026 22:45
@sourcery-ai

sourcery-ai Bot commented Aug 12, 2026

Copy link
Copy Markdown

Reviewer's Guide

Docs PR that re-centers Getting Started around Forge, adds detailed Forge usage and Flow Quick Runner guides with extensive screenshots, and documents v0.0.79 transition execution semantics (Busy-as-mutex, status-neutral updateData, immediate InstanceData persistence) and tracing changes across blog, breaking-changes, and workflow component docs in both TR and EN.

Sequence diagram for Busy-as-mutex transition execution model

sequenceDiagram
    actor Client
    participant Runtime

    Client->>Runtime: stateTransition
    alt instance Active
        Runtime->>Runtime: [status lock Active→Busy]
        Runtime->>Runtime: [run transition pipeline]
        Runtime->>Runtime: [evaluate auto transitions]
    else instance Busy
        Runtime-->>Client: 409 Conflict
    end

    Client->>Runtime: cancel
    Runtime->>Runtime: [status lock]
    Runtime->>Runtime: [bypass Busy check]
    Runtime->>Runtime: [start cancel flow]

    Client->>Runtime: exit
    Runtime->>Runtime: [status lock]
    Runtime->>Runtime: [bypass Busy check]
    Runtime->>Runtime: [start exit flow]

    Client->>Runtime: updateData
    Runtime->>Runtime: [no status lock, no Busy check]
    Runtime->>Runtime: [persist InstanceData rows]
    Runtime->>Runtime: [evaluate autos at order 90]
    Runtime-->>Client: updateData response
Loading

Flow diagram for Forge-first development environment setup

flowchart LR
    A[Install vNextForgeExtension] --> B[Install AIToolkitPlugin]
    B --> C[CreateProject via vnext-init or ForgeCreateProject]
    C --> D[Install WorkflowCLI]
    D --> E[AddEnvironment Local_or_Remote]
    E --> F[DevelopFlows with Forge and QuickRunner]
Loading

File-Level Changes

Change Details Files
Getting Started is restructured to be Forge-first and legacy local-dev/multi-domain guides are archived with warnings, including new Forge setup docs in TR and EN and sidebar navigation updates.
  • Sidebars now point Getting Started to the new Forge setup doc instead of local-dev/multi-domain, and add a collapsible Archive category
  • Local Development and Multi-Domain guides are moved under docs/archive/ with archive warnings and updated titles/descriptions in both TR and EN locales
  • New Forge setup guide documents end-to-end environment setup via Forge, CLI installation, local/remote environment management, AI toolkit integration, and ties to runtime/CLI repos
  • Intro and Getting Started index pages are updated to describe the Forge-based onboarding path and remove references to manual docker-compose setup
sidebars.ts
docs/getting-started/index.md
i18n/en/docusaurus-plugin-content-docs/current/getting-started/index.md
docs/getting-started/local-dev.md
docs/archive/local-dev.md
docs/getting-started/multi-domain.md
docs/archive/multi-domain.md
i18n/en/docusaurus-plugin-content-docs/current/getting-started/local-dev.md
i18n/en/docusaurus-plugin-content-docs/current/archive/local-dev.md
i18n/en/docusaurus-plugin-content-docs/current/getting-started/multi-domain.md
i18n/en/docusaurus-plugin-content-docs/current/archive/multi-domain.md
docs/getting-started/forge-setup.md
i18n/en/docusaurus-plugin-content-docs/current/getting-started/forge-setup.md
docs/archive/index.md
i18n/en/docusaurus-plugin-content-docs/current/archive/index.md
docs/intro.md
i18n/en/docusaurus-plugin-content-docs/current/intro.md
docs/getting-started/tutorial.md
New Forge Usage and Flow Quick Runner tool guides are added with rich, annotated screenshots and cross-links, and the existing Forge Studio docs are wired to the new usage guide.
  • Tools index gains pointers to the Forge usage guide alongside existing tool docs
  • New Forge usage guide explains all Forge Tools panels, Explorer context menus, per-component designers, CSX sync, and the publish-CLI relationship (TR+EN)
  • New Flow Quick Runner guide documents the Quick Run UI regions, starting instances, firing transitions with schema-based forms/Generate, state view pseudo-ui rendering, instance data/history/correlations/raw, long-polling, and Function Quick Runner (TR+EN)
  • Forge Studio doc now links to the portal-hosted Forge usage guide and clarifies the GitHub usage guide as the source reference
docs/tools/index.md
docs/tools/forge-studio.md
docs/tools/forge-usage.md
i18n/en/docusaurus-plugin-content-docs/current/tools/forge-usage.md
docs/tools/quick-runner.md
i18n/en/docusaurus-plugin-content-docs/current/tools/quick-runner.md
static/img/tools/forge/*
Workflow component docs in TR and EN gain a new Transition Execution Model section describing Busy-as-mutex locking, status-neutral reserve semantics for updateData, and immediate per-instance locked InstanceData persistence, with design guidance.
  • Adds a dedicated Transition Execution Model section explaining status lock behavior per transition type, Busy-as-mutex, and the removal of long-lease chain-token locking in TR workflow docs
  • Documents updateData as a reserve transition, including behavior on plain instances vs active subflows, auto evaluation after each updateData, and flow-design notes in TR
  • Mirrors the Transition Execution Model and updateData semantics in EN workflow docs, and calls out Busy-as-mutex + updateData v2 in the v0.0.79 what’s-new section
  • Updates the Update Data transition descriptions in both TR and EN to reference the new execution model and changed semantics (status-neutral, parent-handled in subflows)
docs/components/workflow.md
i18n/en/docusaurus-plugin-content-docs/current/components/workflow.md
Release v0.0.79 and breaking-changes blog posts are updated for the new release date, Busy-as-mutex/updateData semantics, InstanceData persistence model, and business-focused tracing, including links back into workflow docs.
  • Release blog frontmatter date and tags are bumped from 2026-08-11 to 2026-08-13 and now include transitions/observability
  • Overview section now describes Busy-as-mutex locking, status-neutral reserve updateData, and immediate InstanceData persistence under per-instance version locking, plus Aether 1.0.34 business-focused tracing attributes and default detail level
  • Features section gains detailed subsections for Busy-as-mutex/updateData (#877) and business-focused tracing (#874), including admission matrix, behavior per transition type, InstanceData write model, and tracing taxonomy/config examples
  • Behavior Changes section calls out the locking rework as behavior-changing (409 on Busy, no subflow forwarding for updateData, chain-token dropped) and points to the v0.0.79 breaking-changes announcement
  • Release configuration/bullets add references to PRs #877 and #874 and summarize Busy-as-mutex and tracing behaviors; footer release date is updated
  • Breaking-changes blog frontmatter date is updated to 2026-08-13 and intro now mentions Busy-as-mutex; new sections 8–10 document chain-token removal, updateData semantics change, and InstanceData write model change, each with impact/migration guidance
blog/2026-08-13-v0-0-79.md
blog-breaking-changes/2026-08-13-v0-0-79.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 0043dd14-9ea5-4b71-af16-a2e412411c0c

📥 Commits

Reviewing files that changed from the base of the PR and between 0b3f0ab and 9c7c62b.

⛔ Files ignored due to path filters (35)
  • static/img/tools/forge/context-menu-file.png is excluded by !**/*.png
  • static/img/tools/forge/context-menu-folder.png is excluded by !**/*.png
  • static/img/tools/forge/create-project.png is excluded by !**/*.png
  • static/img/tools/forge/designer-extension-config.png is excluded by !**/*.png
  • static/img/tools/forge/designer-extension.png is excluded by !**/*.png
  • static/img/tools/forge/designer-function-config.png is excluded by !**/*.png
  • static/img/tools/forge/designer-function.png is excluded by !**/*.png
  • static/img/tools/forge/designer-mapping-config.png is excluded by !**/*.png
  • static/img/tools/forge/designer-mapping.png is excluded by !**/*.png
  • static/img/tools/forge/designer-schema-config.png is excluded by !**/*.png
  • static/img/tools/forge/designer-schema.png is excluded by !**/*.png
  • static/img/tools/forge/designer-task-config.png is excluded by !**/*.png
  • static/img/tools/forge/designer-task.png is excluded by !**/*.png
  • static/img/tools/forge/designer-view-config.png is excluded by !**/*.png
  • static/img/tools/forge/designer-view.png is excluded by !**/*.png
  • static/img/tools/forge/designer-workflow.png is excluded by !**/*.png
  • static/img/tools/forge/environment-local-actions.png is excluded by !**/*.png
  • static/img/tools/forge/environment-remote.png is excluded by !**/*.png
  • static/img/tools/forge/environments-add.png is excluded by !**/*.png
  • static/img/tools/forge/extension-install.png is excluded by !**/*.png
  • static/img/tools/forge/forge-tools-panels.png is excluded by !**/*.png
  • static/img/tools/forge/function-quick-run-response.png is excluded by !**/*.png
  • static/img/tools/forge/function-quick-run.png is excluded by !**/*.png
  • static/img/tools/forge/package-deploy.png is excluded by !**/*.png
  • static/img/tools/forge/project-panel.png is excluded by !**/*.png
  • static/img/tools/forge/quick-run-fire-transition.png is excluded by !**/*.png
  • static/img/tools/forge/quick-run-history.png is excluded by !**/*.png
  • static/img/tools/forge/quick-run-instance-details.png is excluded by !**/*.png
  • static/img/tools/forge/quick-run-new-run.png is excluded by !**/*.png
  • static/img/tools/forge/quick-run-overview-annotated.png is excluded by !**/*.png
  • static/img/tools/forge/quick-run-raw.png is excluded by !**/*.png
  • static/img/tools/forge/quick-run-state-view.png is excluded by !**/*.png
  • static/img/tools/forge/quick-run-summary-view.png is excluded by !**/*.png
  • static/img/tools/forge/quick-run.png is excluded by !**/*.png
  • static/img/tools/forge/settings-panel.png is excluded by !**/*.png
📒 Files selected for processing (24)
  • blog-breaking-changes/2026-08-13-v0-0-79.md
  • blog/2026-08-13-v0-0-79.md
  • docs/archive/index.md
  • docs/archive/local-dev.md
  • docs/archive/multi-domain.md
  • docs/components/workflow.md
  • docs/getting-started/forge-setup.md
  • docs/getting-started/index.md
  • docs/getting-started/tutorial.md
  • docs/intro.md
  • docs/tools/forge-studio.md
  • docs/tools/forge-usage.md
  • docs/tools/index.md
  • docs/tools/quick-runner.md
  • i18n/en/docusaurus-plugin-content-docs/current/archive/index.md
  • i18n/en/docusaurus-plugin-content-docs/current/archive/local-dev.md
  • i18n/en/docusaurus-plugin-content-docs/current/archive/multi-domain.md
  • i18n/en/docusaurus-plugin-content-docs/current/components/workflow.md
  • i18n/en/docusaurus-plugin-content-docs/current/getting-started/forge-setup.md
  • i18n/en/docusaurus-plugin-content-docs/current/getting-started/index.md
  • i18n/en/docusaurus-plugin-content-docs/current/intro.md
  • i18n/en/docusaurus-plugin-content-docs/current/tools/forge-usage.md
  • i18n/en/docusaurus-plugin-content-docs/current/tools/quick-runner.md
  • sidebars.ts

📝 Walkthrough

Walkthrough

The PR documents v0.0.79 workflow execution changes and adds Forge setup, usage, Quick Runner, archive, and navigation documentation in Turkish and English.

Changes

Workflow and release documentation

Layer / File(s) Summary
Transition execution and persistence model
blog-breaking-changes/..., docs/components/workflow.md, i18n/en/.../components/workflow.md
The documentation describes Busy-as-mutex execution, status-neutral updateData, retry behavior, subflow handling, and immediate InstanceData persistence.
v0.0.79 release notes
blog/2026-08-13-v0-0-79.md, blog-breaking-changes/2026-08-13-v0-0-79.md
The release notes update the date and record transition, persistence, tracing, migration, and issue-reference changes.

Forge documentation and navigation

Layer / File(s) Summary
Forge development environment setup
docs/getting-started/..., i18n/en/.../getting-started/..., docs/intro.md, sidebars.ts
New guides document Forge installation, project creation, CLI setup, runtime and environment management, workflow development, and troubleshooting. Getting Started navigation now points to Forge setup.
Forge tools and Quick Runner guides
docs/tools/..., i18n/en/.../tools/..., sidebars.ts
New guides document Forge panels, designers, publishing, workflow and function execution, monitoring, and diagnostics.
Archived documentation organization
docs/archive/..., i18n/en/.../archive/..., sidebars.ts
Archive pages identify obsolete setup guides, preserve manual references, and link to Forge-based replacements.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Possibly related PRs

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch f/v0-0-79-docs

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@yilmaztayfun yilmaztayfun self-assigned this Aug 12, 2026
@yilmaztayfun
yilmaztayfun merged commit 9451f70 into main Aug 12, 2026
3 of 4 checks passed

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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