fix(docs): resolve mermaid syntax errors#259
Open
Kairos-T wants to merge 2 commits intovxcontrol:mainfrom
Open
fix(docs): resolve mermaid syntax errors#259Kairos-T wants to merge 2 commits intovxcontrol:mainfrom
Kairos-T wants to merge 2 commits intovxcontrol:mainfrom
Conversation
Signed-off-by: Kairos <contact@kairostay.com>
- added the previously stripped parentheses Signed-off-by: Kairos <contact@kairostay.com>
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.
Description of the Change
Problem
A Mermaid diagram in
backend/docs/flow_execution.mddoes not render in the Markdown preview due to invalidNote oversyntax:Note overis 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
Areas Affected
Testing and Verification
Test Steps
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
backend/docs/flow_execution.mdDeployment Notes
None
Checklist
Code Quality
Compatibility
Documentation
Additional Notes