Skip to content

docs: map Bible read cache for agents - #372

Closed
cameronapak wants to merge 1 commit into
cursor/cp/ype-5453-cache-control-lifetime-d890from
cursor/cp/bible-read-cache-docs-a14b
Closed

docs: map Bible read cache for agents#372
cameronapak wants to merge 1 commit into
cursor/cp/ype-5453-cache-control-lifetime-d890from
cursor/cp/bible-read-cache-docs-a14b

Conversation

@cameronapak

@cameronapak cameronapak commented Sep 1, 2026

Copy link
Copy Markdown
Collaborator

Docs-only follow-up for YPE-5453 / #371. No runtime, test, or changeset changes. Does not implement YPE-5262.

Why

An agent should read AGENTS.md then docs/bible-read-cache.md and know who owns GET, which files to touch, what remount must do, and that Expo disk cache is a different ticket.

What this adds

  • docs/bible-read-cache.md: tower, opt-in list, remount contract table, fence, file ownership, agent control.
  • Root AGENTS.md: Domain pointer to the map.
  • CONTEXT.md: opted-in Bible read, remaining lifetime, CachePolicy, getWithPolicy, memory-only (plus remount / still-mounted observer).
  • ADR 0006: a How to navigate block. The ADR stays the why. The map is the how and where.
  • packages/core/AGENTS.md: CachePolicy / getWithPolicy. GET stays body-only.
  • packages/hooks/AGENTS.md: map pointer plus a 5-row remount contract table.
  • docs/testing.md: remount tests stay in hooks; core owns the parseCachePolicy table.

Fence (repeated in the map, CONTEXT, core, hooks, ADR)

  • Do not use this layer as the React Native Expo disk cache.
  • Do not persist QueryClient.
  • Do not share one QueryClient across Expo WebViews.
  • Do not wrap window.fetch in the Web SDK to close YPE-5262.

Verification

git diff against this branch is markdown only. No .ts, .tsx, or changeset files.

Open in Web Open in Cursor 

Point AGENTS, CONTEXT, ADR 0006, and package guides at one how/where map so remaining lifetime stays a memory-only opted-in Bible read.

Co-authored-by: Cameron Pak <cameronandrewpak@gmail.com>
@changeset-bot

changeset-bot Bot commented Sep 1, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 85e866b

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@cameronapak cameronapak closed this Sep 1, 2026
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.

2 participants