From 0ee6a392f7b9e809d9bf6d477fe71ba5d99f65d0 Mon Sep 17 00:00:00 2001
From: shreyadesai20042009
 <165306341+shreyadesai20042009@users.noreply.github.com>
Date: Wed, 28 Jan 2026 22:47:54 +0530
Subject: [PATCH] Add known issues documentation for speedy routing

Document known issues with speedy isobased routing and provide suggested workarounds.
---
 docs/known_issues.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 docs/known_issues.md

diff --git a/docs/known_issues.md b/docs/known_issues.md
new file mode 100644
index 0000000..68db300
--- /dev/null
+++ b/docs/known_issues.md
@@ -0,0 +1,31 @@
+---
+
+## Known Issues
+
+### Speedy IsoBased Routing with Test Data
+
+When using the `speedy_isobased` algorithm with the provided
+test weather and depth datasets, routing may terminate early
+with the error:
+
+> All pruning segments fully constrained
+
+#### Symptoms
+- Routing stops after ~10–11 isochrone steps
+- No runtime exception occurs
+- No route reaches the destination
+- A partial route file is generated with 0% success
+
+#### Cause (Observed)
+This occurs when all isochrone pruning segments become constrained
+due to the interaction of:
+- Pruning parameters
+- Environmental constraints (land, depth, map bounds)
+- Test data resolution
+
+#### Suggested Workarounds
+Users may try:
+- Increasing `ISOCHRONE_PRUNE_SEGMENTS`
+- Reducing `ISOCHRONE_PRUNE_SECTOR_DEG_HALF`
+- Increasing heading resolution
+- Reducing pruning strictness