Updates to README for platform architecture overview#5
Merged
emsearcy merged 6 commits intolinuxfoundation:mainfrom Jul 23, 2025
Merged
Updates to README for platform architecture overview#5emsearcy merged 6 commits intolinuxfoundation:mainfrom
emsearcy merged 6 commits intolinuxfoundation:mainfrom
Conversation
Include a list of components and diagram. Signed-off-by: Eric Searcy <eric@linuxfoundation.org>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates documentation to include a detailed list of platform components and a Mermaid diagram, and refines chart descriptions.
- Revised chart README and Chart.yaml descriptions for LFX v2
- Updated top-level README’s file tree and component list
- Added new infrastructure and custom components section with a Mermaid architecture diagram
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| charts/lfx-platform/README.md | Adjusted the chart overview wording to highlight platform services and APIs |
| charts/lfx-platform/Chart.yaml | Changed description casing from “V2” to “v2” |
| README.md | Restructured file tree, overhauled Components list, and inserted a Mermaid diagram |
Comments suppressed due to low confidence (4)
README.md:9
- The ASCII tree now nests
charts/directly under the root, which may misrepresent the repository structure. Consider restoring thelfx-v2-helm/root entry and adjusting indentation to accurately reflect the directory hierarchy.
└── charts/
README.md:40
- This line is missing a leading hyphen and space to render as a markdown list item. Prefix with
-to ensure it appears as a bullet point.
LFX v2 includes the following infrastructure components:
README.md:76
- Mermaid node definitions use
{},[], or(), but the@{syntax is invalid. Replace@{with the proper brace syntax, e.g.,nats-access-check-subject{ ... }.
nats-access-check-subject@{ shape: braces, label: "access-check & replies" }
README.md:96
- The
query-svcnode is defined here after being referenced earlier, leading to a duplicate declaration. Define the node once before references to avoid rendering issues.
query-svc[<em>query-svc</em>]
jordane
reviewed
Jul 10, 2025
Signed-off-by: Eric Searcy <eric@linuxfoundation.org>
jordane
reviewed
Jul 22, 2025
Signed-off-by: Eric Searcy <eric@linuxfoundation.org>
Signed-off-by: Eric Searcy <eric@linuxfoundation.org>
Signed-off-by: Eric Searcy <eric@linuxfoundation.org>
jordane
approved these changes
Jul 23, 2025
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.
Include a list of components and diagram.