Skip to content

Learning fuel crawlability checklist and telemetry - #62

Merged
sis0k0 merged 6 commits into
mainfrom
crawlability-checklist-and-telemetry
Aug 28, 2026
Merged

sis0k0 merged 6 commits into
mainfrom
crawlability-checklist-and-telemetry

Conversation

@sis0k0

@sis0k0 sis0k0 commented Aug 28, 2026

Copy link
Copy Markdown
Member

Summary

Applies the MongoDB developer repository checklist to this repo and adds Codespaces lifecycle telemetry matching mean-stack-example/mern-stack-example.

New files

  • AGENTS.md — build/test commands, project structure, API and env var reference for coding agents.
  • EDD.md — the MongoDB data model, with field types sampled from the actual seeded BSON data rather than the TypeScript interfaces alone. Surfaced a few real quirks along the way (a books.embeddings field required by the search-indexing scripts but absent from the seed data, a nullable reviews.text, and an unused operations collection) — documented, not changed, since the dataset is shared across other contexts.
  • .claude/settings.json — enables the official MongoDB Claude plugin.
  • .github/workflows/tests.yml — CI: server lint + API tests against a mongo:latest service container, plus a client build.
  • .devcontainer/track.sh — best-effort Codespaces created/started telemetry, wired into the existing updateContentCommand/postStartCommand hooks.

README changes

Rewritten as a product pitch: capabilities, an architecture diagram, a Codespaces quick start, and a "Why MongoDB?" section tying the schema design patterns already used in the code (Attribute, Extended Reference, Subset, Single Collection) to what the app actually needs. Also gave the MongoDB client a repo-specific appName instead of one shared with other Developer Days workshops, and updated "Atlas Search"/"Atlas Vector Search" mentions to "MongoDB Search"/"MongoDB Vector Search" to match the rename already applied elsewhere in the repo.

sis0k0 added 3 commits August 28, 2026 15:12
Add AGENTS.md and EDD.md, enable the mongodb Claude plugin, wire up a
CI workflow against a local mongo service, and rewrite the README as a
product pitch with a Codespaces badge, architecture diagram, and a
Why MongoDB section. Also give the MongoDB client a repo-specific
appName instead of one shared with other Developer Days workshops.
Mirrors the track.sh pattern from mean-stack-example and
mern-stack-example: a best-effort POST to the learning-fuel tracking
endpoint on codespace creation and start, wired into the existing
updateContentCommand/postStartCommand hooks.
…tor Search

Matches the product rename already applied elsewhere in this repo
(see #60).
sis0k0 added 3 commits August 28, 2026 15:21
Pre-existing indentation errors on the "REPLACE_WITH" placeholder
comment blocks in search-indexing/, only visible now that CI actually
runs eslint. Reindents the comment lines to match their surrounding
object literals; no logic changed.
ReviewsController.getReview constructed an ObjectId directly from the
route param. mongodb driver v7 throws on 12-character strings that
aren't valid hex (previously tolerated as raw 12-byte input), which
was uncaught by the intended not-found path and surfaced as a 500.
Guard with ObjectId.isValid first, matching what
reviews.spec.ts already expects.
@sis0k0
sis0k0 merged commit a074696 into main Aug 28, 2026
4 checks passed
@sis0k0
sis0k0 deleted the crawlability-checklist-and-telemetry branch August 28, 2026 12:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant