docs: commit the pending media.md and search.md contract updates #11

New issue

Open

opened 2026-07-23 10:29:35 +00:00 by gravityfargo · 0 comments

gravityfargo commented

2026-07-23 10:29:35 +00:00

Owner

Found in the 2026-07-23 full FE/BE audit.

The working tree at ~/Projects/athena-docs has 52 lines of uncommitted changes across three area pages. Per both repos' CLAUDE.md, these pages are "the agreed contract between the two repos" and "Code and docs must not drift." Right now the published contract at athena-archive.org is behind the code, and the reconciliation only exists on one machine.

docs/development/iiif.md   | 19 ++++++++++++++
docs/development/media.md  |  7 +++--
docs/development/search.md | 29 ++++++++++++++++++-

search.md (+29)

Documents the public search feature that already ships: no dedicated backend endpoint, the list endpoints' search param reused, /search?q= fanning out to GET /itemset/ and GET /item/ in parallel, media deliberately excluded, results filtered to is_public: true + status: "active" through getPublicClient() + publicCache(...), 48 per side, no pagination, robots: { index: false }. The committed page is still the one-line stub "The search feature for finding objects."

This also closes an open item on ModernLeft/athena-frontend#444, which lists "Public search UI" as missing — it is not missing any more, and the docs are where that gets recorded.

media.md (+7/-2)

Records that remote-URL upload has been retired from the frontend and upload is direct-file only. The backend still exposes POST /media/upload-from-url/ with no consumer; ModernLeft/athena-api#357 tracks the retire-or-keep decision, and whichever way that lands, this page is where the answer belongs.

iiif.md (+19)

Already tracked by #7 (iiif.md overstates the API surface). The fix appears to be written; it just needs committing.

Commit all three, then #7 can close.

Found in the 2026-07-23 full FE/BE audit. The working tree at `~/Projects/athena-docs` has 52 lines of uncommitted changes across three area pages. Per both repos' `CLAUDE.md`, these pages are *"the agreed contract between the two repos"* and *"Code and docs must not drift."* Right now the published contract at athena-archive.org is behind the code, and the reconciliation only exists on one machine. ``` docs/development/iiif.md | 19 ++++++++++++++ docs/development/media.md | 7 +++-- docs/development/search.md | 29 ++++++++++++++++++- ``` ## search.md (+29) Documents the public search feature that already ships: no dedicated backend endpoint, the list endpoints' `search` param reused, `/search?q=` fanning out to `GET /itemset/` and `GET /item/` in parallel, media deliberately excluded, results filtered to `is_public: true` + `status: "active"` through `getPublicClient()` + `publicCache(...)`, 48 per side, no pagination, `robots: { index: false }`. The committed page is still the one-line stub *"The search feature for finding objects."* This also closes an open item on ModernLeft/athena-frontend#444, which lists "Public search UI" as missing — it is not missing any more, and the docs are where that gets recorded. ## media.md (+7/-2) Records that remote-URL upload has been retired from the frontend and upload is direct-file only. The backend still exposes `POST /media/upload-from-url/` with no consumer; ModernLeft/athena-api#357 tracks the retire-or-keep decision, and whichever way that lands, this page is where the answer belongs. ## iiif.md (+19) Already tracked by #7 (iiif.md overstates the API surface). The fix appears to be written; it just needs committing. Commit all three, then #7 can close.

No labels

No milestone

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

ModernLeft/athena-docs#11

No description provided.

Rows
Columns