docs: update or remove outdated issue/backlog and gap matrix text #106

New issue

2026-04-22T03:24:24Z

PlasticDigits commented

2026-04-22 03:24:24 +00:00

(Migrated from gitlab.com)

Summary

Several issues and architecture notes in docs are out of date relative to current main or partially superseded. This issue tracks updating, superseding, or removing that text so GitLab/ADR/backlog and in-repo reviews do not contradict the implementation.

Items to update (initial list; verify at edit time)

`docs/reviews/20260409T030009Z/ISSUE_BACKLOG.md`

DEX-P1-001 — Limit book visibility API or LCD playbook
Status: Largely implemented: indexer exposes GET /api/v1/pairs/{addr}/order-book-head and .../limit-book-shallow; LimitOrdersPage consumes shallow book. Action: mark done or narrow remaining scope to deep book / pagination (link deep-book epic) and remove “LCD playbook only” language if no longer true.
DEX-P1-010 / E2E references — align with new policy: E2E must not skip for funding on default path (separate issue).
DEX-P0-EPIC — Best execution — still valid at product level; cross-link to new indexer best execution gate issue.

`docs/reviews/20260409T030009Z/ARCHITECTURE_GAP_MATRIX.md`

Hybrid route selection — route_solver POST now supports hybrid_by_hop + LCD sim; GET is still pool-only. Update matrix cells P/M to match or point to the new hybrid multihop epic.
Order book HTTP API — “LCD only” for user-visible state is stale if indexer proxy exists; refresh E/P/M column.
Test coverage (hybrid E2E) — still partial due to test.skip; note conditional or link strict E2E issues.

`docs/limit-orders.md` & `docs/indexer-invariants.md`

Shallow depth (10 default, 20 max): keep accurate until deep book work lands; then update invariants and ADR 0002 references.
Invariants table: on-chain book row references shallow — update when API changes.

`docs/testing.md`

Reconcile “stub at service layer” with new chart integration tests requirement.

Acceptance criteria

A single PR (or one per file if preferred) updates or strikes through resolved backlog items; adds “Last reviewed YYYY-MM-DD” in review doc headers where applicable.
ISSUE_BACKLOG.md no longer lists open items that are already shipped without a “done” or “moved to GitLab #IID” line.
ARCHITECTURE_GAP_MATRIX.md legend or footer notes that some rows are historical and points to GitLab for live tracking.

Labels suggested

documentation, architecture, tech-debt

## Summary Several **issues and architecture notes** in **docs** are **out of date** relative to current `main` or partially superseded. This issue tracks **updating, superseding, or removing** that text so GitLab/ADR/backlog and **in-repo** reviews do not contradict the implementation. ## Items to update (initial list; verify at edit time) ### `docs/reviews/20260409T030009Z/ISSUE_BACKLOG.md` - **DEX-P1-001 — Limit book visibility API or LCD playbook** **Status:** Largely **implemented**: indexer exposes `GET /api/v1/pairs/{addr}/order-book-head` and `.../limit-book-shallow`; `LimitOrdersPage` consumes shallow book. **Action:** mark **done** or **narrow** remaining scope to **deep book / pagination** (link deep-book epic) and remove “LCD playbook only” language if no longer true. - **DEX-P1-010 / E2E** references — align with new policy: **E2E must not skip** for funding on default path (separate issue). - **DEX-P0-EPIC — Best execution** — still valid at **product** level; cross-link to new **indexer best execution gate** issue. ### `docs/reviews/20260409T030009Z/ARCHITECTURE_GAP_MATRIX.md` - **Hybrid route selection** — `route_solver` **POST** now supports `hybrid_by_hop` + LCD sim; **GET** is still pool-only. Update matrix cells **P/M** to match or point to the **new hybrid multihop** epic. - **Order book HTTP API** — “LCD only” for **user-visible** state is **stale** if indexer proxy exists; refresh **E/P/M** column. - **Test coverage (hybrid E2E)** — still **partial** due to `test.skip`; note **conditional** or link strict E2E issues. ### `docs/limit-orders.md` & `docs/indexer-invariants.md` - **Shallow** depth (10 default, 20 max): keep accurate until **deep book** work lands; then update **invariants** and **ADR 0002** references. - Invariants table: **on-chain book** row references **shallow** — update when API changes. ### `docs/testing.md` - Reconcile “stub at service layer” with new **chart integration** tests requirement. ## Acceptance criteria - [ ] A single **PR** (or one per file if preferred) updates or **strikes through** resolved backlog items; adds **“Last reviewed YYYY-MM-DD”** in review doc headers where applicable. - [ ] `ISSUE_BACKLOG.md` no longer lists **open** items that are **already shipped** without a “done” or “moved to GitLab #IID” line. - [ ] `ARCHITECTURE_GAP_MATRIX.md` legend or footer notes that some rows are **historical** and points to **GitLab** for live tracking. ## Labels suggested `documentation`, `architecture`, `tech-debt`

PlasticDigits commented

2026-04-22 03:24:50 +00:00

(Migrated from gitlab.com)

mentioned in issue #107

PlasticDigits commented

2026-04-22 04:59:55 +00:00

(Migrated from gitlab.com)

mentioned in commit 844607a438

mentioned in commit 844607a43804ca154ecdb789267e326c961bb657

PlasticDigits commented

2026-04-22 05:00:52 +00:00

(Migrated from gitlab.com)

Done — docs synced to `main` (commit `844607a`)

@brouie Could you verify this matches what you had in mind for #106?

What changed

ISSUE_BACKLOG.md: Added Last reviewed header and GitLab as live source of truth. DEX-P1-001 marked shipped for shallow book + indexer proxy (order-book-head, limit-book-shallow, LimitOrdersPage); remaining depth/pagination points to #102. DEX-P1-010 now references limit-orders-tx.spec.ts, #72, and the no-skip-on-default-path policy #103. DEX-P0-EPIC cross-links #108 (indexer best execution) and #56. DEX-P1-004 updated for POST hybrid_by_hop + #101. Dependency graph and suggested sprint list adjusted.
ARCHITECTURE_GAP_MATRIX.md: Status cells updated (order book API, user-visible book, hybrid route selection, indexer hybrid quotes, hybrid E2E coverage, quote vs hybrid/L8). Added historical snapshot banner, Last reviewed, and footer pointing to GitLab for live tracking.
limit-orders.md / indexer-invariants.md: Clarified shallow-only proxy and links to #102 (deep book) and #101 (GET hybrid routes).
testing.md: Clarified that service-layer stubs in Vitest unit tests are intentional; chart/indexer-style coverage is separate (#104).
Review bundle README.md: Last reviewed line.

Verification

Doc-only change; pre-commit (fmt, clippy, gitleaks) passed on the branch. No runtime tests required for content, but a quick read of the six files for tone/links would be appreciated.

Branch docs/glab-106-review-sync was merged into main and pushed to origin.

## Done — docs synced to `main` (commit 844607a) @brouie Could you verify this matches what you had in mind for #106? ### What changed - **`ISSUE_BACKLOG.md`:** Added **Last reviewed** header and GitLab as live source of truth. **DEX-P1-001** marked **shipped** for shallow book + indexer proxy (`order-book-head`, `limit-book-shallow`, `LimitOrdersPage`); remaining depth/pagination points to **#102**. **DEX-P1-010** now references `limit-orders-tx.spec.ts`, **#72**, and the no-skip-on-default-path policy **#103**. **DEX-P0-EPIC** cross-links **#108** (indexer best execution) and **#56**. **DEX-P1-004** updated for `POST` `hybrid_by_hop` + **#101**. Dependency graph and suggested sprint list adjusted. - **`ARCHITECTURE_GAP_MATRIX.md`:** Status cells updated (order book API, user-visible book, hybrid route selection, indexer hybrid quotes, hybrid E2E coverage, quote vs hybrid/L8). Added **historical snapshot** banner, **Last reviewed**, and footer pointing to GitLab for live tracking. - **`limit-orders.md` / `indexer-invariants.md`:** Clarified **shallow-only** proxy and links to **#102** (deep book) and **#101** (GET hybrid routes). - **`testing.md`:** Clarified that service-layer stubs in Vitest unit tests are intentional; chart/indexer-style coverage is separate (**#104**). - **Review bundle `README.md`:** **Last reviewed** line. ### Verification - Doc-only change; pre-commit (fmt, clippy, gitleaks) passed on the branch. No runtime tests required for content, but a quick read of the six files for tone/links would be appreciated. Branch `docs/glab-106-review-sync` was merged into `main` and pushed to `origin`.

Brouie commented

2026-04-22 06:27:47 +00:00

(Migrated from gitlab.com)

@PlasticDigits acknowledging — dev docs work (ISSUE_BACKLOG.md strike-through, ARCHITECTURE_GAP_MATRIX.md cell updates, limit-orders.md / invariants refresh). No QA action until the PR/commit lands, then I'll verify per the acceptance criteria.

PlasticDigits commented

2026-04-22 06:53:33 +00:00

(Migrated from gitlab.com)

@Brouie Commit is merged

Brouie commented

2026-04-23 03:51:41 +00:00

(Migrated from gitlab.com)

@PlasticDigits verified on 844607a.

Docs sync reviewed:

DEX-P1-001 marked done (shallow book + indexer proxy shipped); deep book tracked under #102
DEX-P1-010 aligned with #72 + #103 no-skip funding policy
DEX-P0-EPIC + DEX-P1-004 updated with POST hybrid_by_hop, #108, #101 references
ARCHITECTURE_GAP_MATRIX statuses refreshed, GitLab footnote updated
limit-orders.md + indexer-invariants.md clarify shallow vs deep (#102) and GET hybrid (#101)
testing.md clarifies service stubs vs integration/chart coverage (#104)
Last reviewed headers added to review bundle docs

Cross-checked ISSUE_BACKLOG.md: cross-references are internally consistent, shipped items properly struck through, new GitLab issue numbers match what actually landed.

Closing as verified.

@PlasticDigits verified on `844607a`. Docs sync reviewed: - DEX-P1-001 marked done (shallow book + indexer proxy shipped); deep book tracked under #102 - DEX-P1-010 aligned with #72 + #103 no-skip funding policy - DEX-P0-EPIC + DEX-P1-004 updated with POST hybrid_by_hop, #108, #101 references - ARCHITECTURE_GAP_MATRIX statuses refreshed, GitLab footnote updated - limit-orders.md + indexer-invariants.md clarify shallow vs deep (#102) and GET hybrid (#101) - testing.md clarifies service stubs vs integration/chart coverage (#104) - Last reviewed headers added to review bundle docs Cross-checked ISSUE_BACKLOG.md: cross-references are internally consistent, shipped items properly struck through, new GitLab issue numbers match what actually landed. Closing as verified.

Brouie (Migrated from gitlab.com) closed this issue

2026-04-23 03:51:42 +00:00

Sign in to join this conversation.