docs: README disambiguator + rework Architecture for duroxide/duroxide-pg layering#193
Merged
Conversation
Adds a single-blockquote callout near the top of the README so a reader can immediately tell pg_durable apart from duroxide-pg. Replaces the earlier draft that added a full "Duroxide family" overview here; the overview is now kept only in the duroxide hub README. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
The previous Architecture diagram glossed over duroxide-pg entirely and mislabelled the durable runtime tables as 'duroxide internals' inside the df schema. Update the section to: - Name duroxide (orchestration runtime) and duroxide-pg (PostgreSQL state provider) explicitly and describe what each contributes. - Replace the diagram with a precisely-aligned nested view showing pg_durable -> duroxide -> duroxide-pg -> PostgreSQL, plus the actual schemas (df.* for DSL graphs, duroxide.* for runtime state). - Fold the 'which to pick' guidance (formerly its own 'Relationship With duroxide-pg' section) into the Architecture section as a trailing note, framed correctly: pg_durable is built on top of duroxide and duroxide-pg, not an alternative to them. Also fix two stale items in the old diagram: 'durable.if()' -> 'df.if()' and dropping the misleading '(duroxide internals)' label on the df schema. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
Author
@microsoft-github-policy-service agree [company="{Microsoft}"] |
This was referenced May 29, 2026
Contributor
Author
@microsoft-github-policy-service agree |
pinodeca
approved these changes
May 29, 2026
pinodeca
left a comment
pinodeca
left a comment
Contributor
There was a problem hiding this comment.
Looks good to me: a clear improvement in clarity/detail.
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
2 participants
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.
README changes that clarify how pg_durable relates to duroxide-pg and includes duroxide-pg in the Architecture section.
See also: