Repository navigation
Rewrite root README as a maintainer-grade repository and runtime architecture guide - #1
Merged
Merged
Conversation
Co-authored-by: Mhmod-Hsn <36679595+Mhmod-Hsn@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update root README.md with architecture guide
Rewrite root README as a maintainer-grade repository and runtime architecture guide
Oct 12, 2026
Mhmod-Hsn
approved these changes
Oct 12, 2026
Mhmod-Hsn
marked this pull request as ready for review
October 12, 2026 10:53
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
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.
The root
README.mdis expanded from a brief workspace overview into a comprehensive contributor/maintainer guide aligned with the current codebase and public API. It now documents repository architecture and consumer-facing runtime behavior in depth, with emphasis on cancellation semantics andthrowIfCancelled().Repository and workspace architecture
apps/website,packages/react-submit-flow,.github/workflows, and root config files.Runtime flow and core controller behavior
useSubmitFlow→FlowController→ confirm/cancel/run/result/feedback.FlowStatusvalues and normal transitions.packages/react-submit-flow/src/core/controller.tsas the orchestration core.Action model, typing, and execution results
RunResultvariants.Cancellation and confirmation semantics
AbortSignalandthrowIfCancelled().closeOnConfirmprecedence/behavior.Provider, UI primitives, headless/adapters, and accessibility
SubmitFlowProviderqueue/toast behavior and native dialog behavior.SubmitFlowForm,SubmitFlowRoot,SubmitButton,ActionButton,CancelButton,BackButton,SubmitFeedback).useSubmitFeedback, and accessibility behaviors.