documentation: correct stale index-settings status and monorepo references #8

Merged
david merged 1 commit from documentation/2026-09-17/correct-stale-index-settings-status into main 2026-09-20 03:26:29 +00:00
Owner

Documentation only. Corrects two settled things that were still described as open, and the repo's framing of the retired shoppy monorepo.

README

  • This repo is now stated as the canonical source, not a mirror of the monorepo's indexes/ directory ("Mirrors" → "Supersedes"; the related-repositories entry is marked retired)
  • The product-sync paragraph no longer claims the defaults point at the monorepo path
  • The attribute ranking rule is no longer described as missing from the products settings — only shoppy-categories.json still omits it
  • The private-IP embedder block is retitled "Resolved" and trimmed to cause + fix: the instance now allows the RFC-1918 range, so the settings update succeeds and mxbai registers. It also drops the cited evidence — tasks 503/504 are successful document additions, not failed settings updates, and were enqueued 2026-09-10, not 2026-09-09
  • Hybrid search remains inert because the BFF never sends a hybrid parameter (unchanged)

Research brief — kept as the dated 2026-08-26 record, annotated rather than rewritten:

  • Adds a note header and a new §8 Status update with five points: attribute applied, embedder/private-IP resolved, hybrid unblocked, settings relocated, and product-sync now applying settings with PATCH (it had been calling PUT, which the Kong gateway 405s)
  • Marks the superseded claims inline (§3.4 heading + "server is DOWN", §4.1, §4.4, §5.1 heading, §5.2, §5.3, §6 step 1, §7 bullet) so none still read as current
  • The A/B data and reasoning are untouched

Verified against the live instance 2026-09-17: products index has the attribute rule and a registered mxbai embedder, a settings PATCH succeeds, document additions compute embeddings, and a hybrid search returns 200.

Documentation only. Corrects two settled things that were still described as open, and the repo's framing of the retired `shoppy` monorepo. **README** - This repo is now stated as the **canonical source**, not a mirror of the monorepo's `indexes/` directory ("Mirrors" → "Supersedes"; the related-repositories entry is marked retired) - The `product-sync` paragraph no longer claims the defaults point at the monorepo path - The `attribute` ranking rule is no longer described as missing from the products settings — only `shoppy-categories.json` still omits it - The private-IP embedder block is retitled "Resolved" and trimmed to cause + fix: the instance now allows the RFC-1918 range, so the settings update succeeds and `mxbai` registers. It also drops the cited evidence — tasks 503/504 are successful document additions, not failed settings updates, and were enqueued 2026-09-10, not 2026-09-09 - Hybrid search remains inert because the BFF never sends a `hybrid` parameter (unchanged) **Research brief** — kept as the dated 2026-08-26 record, annotated rather than rewritten: - Adds a note header and a new §8 Status update with five points: `attribute` applied, embedder/private-IP resolved, hybrid unblocked, settings relocated, and `product-sync` now applying settings with `PATCH` (it had been calling `PUT`, which the Kong gateway 405s) - Marks the superseded claims inline (§3.4 heading + "server is DOWN", §4.1, §4.4, §5.1 heading, §5.2, §5.3, §6 step 1, §7 bullet) so none still read as current - The A/B data and reasoning are untouched Verified against the live instance 2026-09-17: products index has the `attribute` rule and a registered `mxbai` embedder, a settings `PATCH` succeeds, document additions compute embeddings, and a hybrid search returns `200`.
The docs described settings problems as still-open and presented the retired
`shoppy` monorepo as the source of truth for the settings files. The README's
products-settings table is synced separately with issue #6.

README:
- This repo is now stated as the canonical source, not a mirror of the monorepo's
  `indexes/` directory. The file table's "Mirrors" column becomes "Supersedes",
  and the related-repositories entry for the monorepo is marked retired.
- The `product-sync` paragraph no longer claims the defaults point at the
  monorepo path; the defaults are documented as resolving to this repo.
- The `attribute` ranking rule is no longer described as missing from the
  products settings — only `shoppy-categories.json` still omits it, so the
  "Recommended fix" preamble and closing bullet say so.
- The private-IP embedder block is described as resolved, not an active failure:
  the instance now allows the RFC-1918 range, so the settings update succeeds and
  `mxbai` is registered. The section is retitled "Resolved" and trimmed to the
  cause and the fix. It also drops the cited evidence — tasks 503/504 are
  successful document additions, not failed settings updates, and were enqueued
  2026-09-10, not 2026-09-09.
- Hybrid search remains inert at query time because the BFF never sends a
  `hybrid` parameter; that part is unchanged.

Research brief (kept as the dated 2026-08-26 record, annotated not rewritten):
- Adds a "Note" header and a new §8 Status update recording the two resolutions,
  the embedder fix, and the settings relocation.
- §8 point 5 records that §7's gateway restriction was actually biting:
  product-sync applied settings with PUT, which the gateway 405s, so settings
  were never applied; it now uses PATCH.
- Marks the superseded claims inline (§3.4 heading + "server is DOWN", §4.1,
  §4.4, §5.1 heading, §5.2, §5.3, §6 step 1, §7 bullet) so none still read as
  current. The A/B data and reasoning are untouched.
- §8 now states the monorepo is retired rather than implying its copies are
  authoritative, and points validation at the canonical files.

Verified against the live instance 2026-09-17: the products index has the
`attribute` rule and a registered `mxbai` embedder, a settings PATCH succeeds,
document additions compute embeddings, and a hybrid search returns 200.
david merged commit f909da31f6 into main 2026-09-20 03:26:29 +00:00
david deleted branch documentation/2026-09-17/correct-stale-index-settings-status 2026-09-20 03:26:30 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No project
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
shoppy/shoppy-index-configuration!8
No description provided.