Add known issues documentation for speedy routing

[shreyadesai20042009]

Related Issue / Discussion

Relates to discussion: #105

Changes

The following documentation changes were implemented:

• Modified documentation to describe a known limitation of the speedy_isobased routing algorithm when used with the provided test weather and depth datasets.
• Added explanation of the symptoms users may experience when the routing algorithm fails to reach the destination.
• Added documentation describing possible causes of the issue.
• Added configuration suggestions and workarounds to help users avoid confusion when running the example datasets.

Further Details

Summary

This pull request improves the documentation of the WeatherRoutingTool by describing a known limitation of the speedy_isobased routing algorithm when used with the provided test weather and depth datasets.

Before the modification:

• Users running the example datasets could experience situations where the speedy_isobased routing algorithm fails to reach the destination.
• This behavior was not clearly documented, which could lead to confusion for new users.

After the modification:

• The documentation explains the symptoms of this issue.
• The likely causes of the behavior are described.
• Possible configuration workarounds are suggested to help users run the routing tool successfully.

These changes aim to improve the user experience and reduce confusion for new users working with the example datasets.

Dependencies

No new dependencies are required for this modification.
This PR only updates documentation.

PR Checklist

In the context of this PR, I:

• have (already previously) filled the 52North Contributor License Agreement and received positive feedback on this matter
• have filled the 52North Contributor License Agreement and am waiting for feedback
• provide unit tests embedded in the WRT test framework (not applicable since this PR only modifies documentation)
• ensure that the code formatter runs without errors/warnings
• ensure that my changes follow the WRT’s guidelines for contributing at the time of the contribution

[kdemmich]

Hi @shreyadesai20042009, thank you for your PR. We appreciate the time and effort that was put into it but, unfortunately, the description does not follow our PR template. We will not evaluate PRs that do not follow our PR template.

[shreyadesai20042009]

Thank you for the feedback. I apologize for not following the PR template earlier. I will now update the pull request description to follow the repository's template and guidelines. Please let me know if any further changes are required.