Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Sequence Diagram Not Showing #352

Conversation

woke02
Copy link

@woke02 woke02 commented Nov 11, 2024

Description

This PR resolves the issue with the sequence diagram not displaying correctly in the documentation. The fix ensures the diagram is visible and accurately represents the intended flow of actions.

Changes Made

  • Diagram Source Update: Corrected the file path or format issues causing the sequence diagram to not display.
  • Formatting Adjustments: Ensured the diagram fits within the page layout and is displayed at the appropriate scale.
  • Diagram Quality Improvements: Enhanced the resolution and clarity of the diagram to improve readability.
Previous Behavior Updated Behavior
Sequence diagram not showing due to path or formatting issues Sequence diagram now displays correctly and is easily readable

Impact of Changes

  • Improved Documentation: With the sequence diagram now visible, users have a clear visual representation of the command flow, enhancing comprehension.
  • Enhanced User Experience: The fixed diagram aids developers and users in understanding the sequence of actions, improving usability.

Testing Steps

  1. Open the relevant section of the documentation and verify that the sequence diagram is displayed correctly.
  2. Ensure that the diagram is clear, readable, and aligns with the description in the text.
  3. Check the file path and format to confirm they follow documentation best practices.

@woke02 woke02 self-assigned this Nov 11, 2024
Copy link

@snowstopxt snowstopxt left a comment

Choose a reason for hiding this comment

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

LGTM

@snowstopxt snowstopxt merged commit 51abecf into AY2425S1-CS2103T-W09-3:master Nov 11, 2024
3 checks passed
Copy link

codecov bot commented Nov 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

@woke02 woke02 added the priority.Medium Good to have label Nov 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority.Medium Good to have
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants