Docs: a comprehensive, structured README - #119
Merged
Merged
Conversation
Rewrite the README from a bare install guide into a full guide to the engine: a features overview, a how-it-works pipeline diagram, install + usage (admin + console + cron + public URL), a core-concepts table, the mapping language (source references, the transformation + operator + filter vocabulary), configuration (storage, split/ gzip, publish gate, delivery targets, lookup tables), preview/audit diagnostics, and — the main addition — an 'Extending & customizing' section with copy-pasteable, verified examples + service registration for every extension point (value resolver, transformation, operator, format, mapping preset, feed type, lookup source, delivery transport, guardrail), plus events and model/service overriding.
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.
Turns the README from a bare install guide into a proper guide to the plugin.
Structure: features overview → how-it-works pipeline diagram → install → usage (admin, console, cron, public URL) → core-concepts table → the mapping language (source references + the transformation/operator/filter vocabulary) → configuration (storage, split/gzip, publish gate, delivery targets, lookup tables) → preview/audit → Extending & customizing → development/testing.
The Extending & customizing section is the main addition: a per-extension-point table (interface + tag) and copy-pasteable, code-verified examples with service registration for value resolvers, transformations, operators, formats, channel presets, feed types, lookup sources, delivery transports and guardrails — plus events (
FeedItemBuiltEvent,FeedPublishBlockedEvent) and model/service overriding. Every referenced class, interface method and builder was checked against the source.Docs-only; no code or dependency changes.