vxcontrol/pentagi
1
0
Fork 0
mirror of https://github.com/vxcontrol/pentagi.git synced 2026-07-21 08:15:23 -04:00
Code Issues 45 Packages Projects Releases 9 Wiki Activity

[PR #259] [MERGED] fix(docs): resolve mermaid syntax errors #273

New Issue
Closed
opened 2026-06-06 22:10:00 -04:00 by yindo · 0 comments
yindo commented 2026-06-06 22:10:00 -04:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/vxcontrol/pentagi/pull/259
Author: @Kairos-T
Created: 4/14/2026
Status: ✅ Merged
Merged: 4/21/2026
Merged by: @asdek

Base: feature/next-release ← Head: main

📝 Commits (2)

  • 9b61afb fix(docs): resolve mermaid syntax errors
  • 7214abe fix(docs): resolve mermaid syntax errors

📊 Changes

1 file changed (+2 additions, -2 deletions)

View changed files

📝 backend/docs/flow_execution.md (+2 -2)

📄 Description

Description of the Change

Problem

A Mermaid diagram in backend/docs/flow_execution.md does not render in the Markdown preview due to invalid Note over syntax:

Unable to render rich display

Parse error on line 21:
... Note over AssistantUA,Ass
----------------------^
Expecting 'SEMI', 'NEWLINE', 'EOF', 'AMP', 'START_LINK', 'LINK', 'LINK_ID', got 'NODE_STRING'

For more information, see https://docs.github.com/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams#creating-mermaid-diagrams

Note over is a sequence diagram directive and is not valid in graph TD (flowchart) diagrams.

Solution

Replaced the two invalid Note over statements with standard flowchart node definitions:

Note over AssistantUA,AssistantDirect: ... -> AssistantNote[Operates independently<br/>from Task/Subtask hierarchy]
Note over Adviser: ... -> AdviserNote["Also used for:<br/>- Mentor (execution monitoring)<br/>- Planner (task planning)"]

None.

Type of Change

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • 📚 Documentation update

Areas Affected

  • Documentation

Testing and Verification

Test Steps

  1. Verified the syntax error on GitHub
  2. Fixed the syntax errors
  3. Verified that the flowchart diagram renders without parse errors

Test Results

Diagrams render successfully after the fix. No parse errors produced by either affected code block.

Security Considerations

None.

Performance Impact

None.

Documentation Updates

  • Other: Fixed Mermaid syntax in backend/docs/flow_execution.md

Deployment Notes

None

Checklist

Code Quality

Compatibility

  • Changes are backward compatible

Documentation

  • Documentation is clear and complete
  • Comments are added for non-obvious code

Additional Notes

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/vxcontrol/pentagi/pull/259 **Author:** [@Kairos-T](https://github.com/Kairos-T) **Created:** 4/14/2026 **Status:** ✅ Merged **Merged:** 4/21/2026 **Merged by:** [@asdek](https://github.com/asdek) **Base:** `feature/next-release` ← **Head:** `main` --- ### 📝 Commits (2) - [`9b61afb`](https://github.com/vxcontrol/pentagi/commit/9b61afb04297e5b15ce3974e9f9c14cb80176e2a) fix(docs): resolve mermaid syntax errors - [`7214abe`](https://github.com/vxcontrol/pentagi/commit/7214abeefb2b8a38f05961a90dd74151fa43ea98) fix(docs): resolve mermaid syntax errors ### 📊 Changes **1 file changed** (+2 additions, -2 deletions) <details> <summary>View changed files</summary> 📝 `backend/docs/flow_execution.md` (+2 -2) </details> ### 📄 Description <!-- Thank you for your contribution to PentAGI! Please fill out this template completely to help us review your changes effectively. Any PR that does not include enough information may be closed at maintainers' discretion. --> ### Description of the Change <!-- We must be able to understand the design of your change from this description. Please provide as much detail as possible. --> #### Problem <!-- Describe the problem this PR addresses --> A Mermaid diagram in `backend/docs/flow_execution.md` does not render in the Markdown preview due to invalid `Note over` syntax: ``` Unable to render rich display Parse error on line 21: ... Note over AssistantUA,Ass ----------------------^ Expecting 'SEMI', 'NEWLINE', 'EOF', 'AMP', 'START_LINK', 'LINK', 'LINK_ID', got 'NODE_STRING' For more information, see https://docs.github.com/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams#creating-mermaid-diagrams ``` `Note over` is a sequence diagram directive and is not valid in graph TD (flowchart) diagrams. #### Solution <!-- Describe your solution and its key aspects --> Replaced the two invalid Note over statements with standard flowchart node definitions: `Note over AssistantUA,AssistantDirect: ...` -> `AssistantNote[Operates independently<br/>from Task/Subtask hierarchy]` `Note over Adviser: ...` -> `AdviserNote["Also used for:<br/>- Mentor (execution monitoring)<br/>- Planner (task planning)"]` <!-- Enter any applicable Issue number(s) here that will be closed/resolved by this PR. --> None. ### Type of Change <!-- Mark with an `x` all options that apply --> - [x] 🐛 Bug fix (non-breaking change which fixes an issue) - [x] 📚 Documentation update ### Areas Affected <!-- Mark with an `x` all components that are affected --> - [x] Documentation ### Testing and Verification <!-- Please describe the tests that you ran to verify your changes and provide instructions so we can reproduce. --> #### Test Steps 1. Verified the syntax error on GitHub 2. Fixed the syntax errors 3. Verified that the flowchart diagram renders without parse errors #### Test Results Diagrams render successfully after the fix. No parse errors produced by either affected code block. ### Security Considerations <!-- Describe any security implications of your changes. For security-related changes, please note any new dependencies, changed permissions, etc. --> None. ### Performance Impact <!-- Describe any performance implications and testing done to verify acceptable performance. Especially important for changes affecting AI agents, memory systems, or data processing. --> None. ### Documentation Updates <!-- Note any documentation changes required by this PR --> - [x] Other: Fixed Mermaid syntax in `backend/docs/flow_execution.md` ### Deployment Notes <!-- Describe any special considerations for deploying this change. Include any new environment variables, configuration changes, or migration steps. --> None ### Checklist <!--- Go over all the following points, and put an `x` in all the boxes that apply. --> #### Code Quality #### Compatibility - [x] Changes are backward compatible #### Documentation - [x] Documentation is clear and complete - [x] Comments are added for non-obvious code ### Additional Notes <!-- Any additional information that would be helpful for reviewers --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-06-06 22:10:00 -04:00
yindo closed this issue 2026-06-06 22:10:00 -04:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
enhancement
help wanted
pull-request
Mirrored from GitHub Pull Request
 question
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: vxcontrol/pentagi#273
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?