Skip to content

docs(queryspace): surface current API contract - #225

Merged
fazpu merged 1 commit into
mainfrom
docs/queryspace-current-contract
Aug 7, 2026
Merged

docs(queryspace): surface current API contract#225
fazpu merged 1 commit into
mainfrom
docs/queryspace-current-contract

Conversation

@fazpu

@fazpu fazpu commented Aug 7, 2026

Copy link
Copy Markdown
Member

Summary

Makes the already-shipped clean query-space cutover visible at the top of the public API reference.

  • Adds a prominent current-contract notice naming the three assured operations.
  • States that the 17 former patterns are examples.* saved queries, with no compatibility or deprecation layer.
  • Corrects “Three things” to “Four things” for the four API guarantees already listed.

Important decisions

  • This is an information-hierarchy correction, not a new documentation section or product contract.
  • The existing detailed API, CLI, and MCP reference remains unchanged.

Sources inspected

  • The deployed page at https://docs.remember.dev/docs/reference/api/
  • Docs Site deployment run 31149590767 for refactor(queryspace): make clean pre-release cut #223
  • website/src/app/docs/reference/api/page.mdx on main
  • The public docs tree for stale dual-surface, compatibility, and deprecation language

Verification

Limitations and follow-up

  • Content-only change; no API, design, or runtime behavior changes.
  • No new navigation or documentation framework was introduced.

Contributor agreement

Signing on behalf of a legal entity (leave blank if accepting individually):

@fazpu
fazpu enabled auto-merge (squash) August 7, 2026 07:39
@fazpu
fazpu merged commit a518828 into main Aug 7, 2026
12 checks passed
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