Skip to content

Updates to README for platform architecture overview#5

Merged
emsearcy merged 6 commits intolinuxfoundation:mainfrom
emsearcy:readme-updates
Jul 23, 2025
Merged

Updates to README for platform architecture overview#5
emsearcy merged 6 commits intolinuxfoundation:mainfrom
emsearcy:readme-updates

Conversation

@emsearcy
Copy link
Contributor

Include a list of components and diagram.

Include a list of components and diagram.

Signed-off-by: Eric Searcy <eric@linuxfoundation.org>
Copilot AI review requested due to automatic review settings July 10, 2025 00:03
@emsearcy emsearcy requested a review from a team as a code owner July 10, 2025 00:03
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 the lfx-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-svc node 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>]

Signed-off-by: Eric Searcy <eric@linuxfoundation.org>
@emsearcy emsearcy requested a review from jordane July 15, 2025 20:06
Signed-off-by: Eric Searcy <eric@linuxfoundation.org>
@emsearcy emsearcy requested a review from a team as a code owner July 22, 2025 18:34
emsearcy added 3 commits July 22, 2025 11:35
Signed-off-by: Eric Searcy <eric@linuxfoundation.org>
Signed-off-by: Eric Searcy <eric@linuxfoundation.org>
@emsearcy emsearcy requested a review from jordane July 22, 2025 23:17
@emsearcy emsearcy merged commit 2bef5af into linuxfoundation:main Jul 23, 2025
3 checks passed
@emsearcy emsearcy deleted the readme-updates branch July 23, 2025 20:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants