This repository was archived by the owner on Aug 3, 2026. It is now read-only.
Professionalize utility customer-service documentation - #1
Merged
Conversation
…d 'What's actually included' The README listed correlation-ID propagation as an architecture principle, but no correlation-ID handling exists in the Mule flows or log config. Relabel it as a stated design intent that is not yet implemented, and add a 'What's actually included' section that accurately inventories the real Mule app artifacts.
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What changed
Reframed the project as a process-layer reference implementation, organized capabilities by domain, and added architecture, customer protection, AI governance, security, and evidence boundaries. Removed fictional support channels and unsupported outcome positioning.
Validation
Documentation-only change; Mule implementation assets are unchanged.
Note
Low Risk
Documentation-only change with no runtime or API code modifications.
Overview
Reframes the README from a marketing-style product overview to a honest process-layer reference implementation narrative, with an upfront disclaimer that examples and outcomes are not production commitments.
Replaces long sections (ASCII architecture, exhaustive endpoint lists, env var blocks, deployment steps, use cases, monitoring, testing, performance claims, fictional support contacts, and “innovative” positioning) with domain capability tables, architecture principles, customer/AI governance expectations, a “what’s actually in the repo” inventory of Mule/RAML/schema/CI assets, and portfolio/related-project links.
Adds explicit boundaries: placeholder credentials, correlation-ID propagation called out as design intent only, and shortened running / license guidance instead of detailed ops runbooks.
Reviewed by Cursor Bugbot for commit 201df45. Bugbot is set up for automated code reviews on this repo. Configure here.