Skip to content

Live pointers to superseded docs/API_INTEGRATION.md need to be resolved #164

Open

Description

@amar-python

Context

docs/API_INTEGRATION.md describes a July 2026 design where the API shelled out to csv_loader.sh. The current design (routers and services in api/, running FastAPI directly) replaced that long ago, and the file carries its own superseded note at the top.

The Project knowledge instructions already flag API_INTEGRATION.md as describing a superseded API. The problem is that the file is still referenced from live docs that new readers hit:

  • README.md and docs/QUICKSTART.md both link to docs/API_INTEGRATION.md as "frontend ↔ backend endpoint mapping"
  • docs/STARTER_GUIDE.md (PR docs: starter guide #63) adds a similar reference in its "Where to go next" pointer list

A new reader following any of these pointers lands on content that describes a design that has not shipped since July. The superseded banner at the top of API_INTEGRATION.md helps, but readers may not scroll back to the top after following a link into a specific section.

Options

Two ways to resolve, both honest. Product owner's call:

(a) Strengthen the superseded banner on docs/API_INTEGRATION.md itself. Add a prominent "DO NOT USE AS CURRENT REFERENCE" header, visible from any anchor link, with pointer to the current source of truth (api/routers/*.py). File stays in the repo for history; live references continue to work but readers are warned loudly.

(b) Remove references to docs/API_INTEGRATION.md from all live docs (README.md, docs/QUICKSTART.md, and docs/STARTER_GUIDE.md once PR #63 merges). File stays in the repo but new readers never find it through navigation. Current API documentation lives entirely in code comments + the OpenAPI schema at /api/docs.

(c) Both — strengthen the banner AND remove live pointers. Belt-and-braces.

Done when

  • Decision taken (a/b/c) and recorded in a comment on this issue
  • Edits applied in one PR, with the resulting state verified: a reader starting from the README cannot land on API_INTEGRATION.md without an explicit "this is historical" signal

Related

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions