chore: sharpen positioning in metadata, README, and add llms.txt#190
Merged
Conversation
- npm description + keywords lead with the Redis-free / your-DB wedge and BullMQ/pg-boss alternative terms (no Bun) - README 'At a glance' facts box stating runtime, storage, distribution, isolation; explicitly corrects common misconceptions (not Bun, not in-memory) - add docs/public/llms.txt with canonical facts and doc links for AI crawlers
GiovaniGuizzo
approved these changes
Jun 21, 2026
merencia
added a commit
that referenced
this pull request
Jun 22, 2026
…cache Master CI went red after merging #189/#190/#191 (all individually green, docs/metadata-only changes). The build job passed, but lint/test/integration failed with missing build outputs (unresolved types; 'Cannot find module .../sidequest/dist/index.cjs'). Root cause: the setup action cached build outputs (**/dist) and the downstream jobs (which do not build) restored them via actions/cache. That cross-job cache handoff is unreliable: even after the build job saved the cache successfully, a downstream job starting seconds later got a cache miss (GitHub Actions cache read-after-write inconsistency, surfacing now that runners were force-migrated to Node 24). A miss left the job with no dist, so type-aware lint and the tests broke. Fix: stop sharing dist across jobs. Cache only dependencies, keyed on the lockfile (stable, high reuse), and have setup always run 'yarn build' so every job has a freshly built workspace. Builds are fast via Turbo. Also switches the deprecated --frozen-lockfile to --immutable.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Makes the public-facing metadata lead with the actual differentiator instead of generic copy, and adds machine-readable canonical facts. Motivated by an AI (Gemini) hallucinating Sidequest as 'Bun-only / in-memory' when answering from memory: the metadata it would crawl was generic, so it filled the gap with the wrong stereotype.
description+keywords(packages/sidequest/package.json): lead with Redis-free / reuse-your-DB and thebullmq-alternative/pg-boss-alternative/postgres-queueterms people and AIs actually search. No Bun.SELECT ... FOR UPDATE SKIP LOCKED), isolation, and built-ins. Directly counters the common misconceptions.docs/public/llms.txt(served at docs.sidequestjs.com/llms.txt): canonical facts + doc links for AI crawlers, following the llms.txt convention.Why
These are the sources LLMs crawl when grounded (a corrected Gemini answer pulled straight from the GitHub README and the site), and the feedstock for aggregators like LibHunt and npm-compare that ingest GitHub topics and npm keywords. Generic metadata both fails search and invites hallucination.
Notes
Migrating from BullMQlink in the README/llms.txt resolves once docs: add Migrating from BullMQ guide #189 merges.