feat: refactor api surface for clarity#1
Merged
Spelkington merged 11 commits intomainfrom Apr 3, 2026
Merged
Conversation
- Install docfx 2.78.5 as .NET local tool
- Enable GenerateDocumentationFile for src/ projects in Directory.Build.props
- Add scripts/docfx-metadata.sh: discovers .csproj files, writes per-project
temp docfx config, outputs markdown to docs/reference/src/{relative-path}/
- Add docs:metadata NX target (default: src, configurations: examples, all)
- Fix truncated <summary> tag on FlowthruCli.RunStandaloneAsync
- Commit initial generated reference docs for all 9 src/ projects (237 files)
shouldSkipMarkup: true is a workaround for a Markdig crash in DocFX 2.78.5
(ArgumentOutOfRangeException in XmlComment.cs). XML doc HTML tags pass through
as valid CommonMark inline HTML, rendering correctly on GitHub and VS Code.
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.
refactors the API surface of the library from:
Pipelines made of Nodes; and
Catalogs made of Entries;
to
Flows made of Steps; and
Catalogs made of Items
As well as other various renames — e.g. "CatalogEntries" to "DataFactory"