docs: surface mentions for temporal-validity (post-RFC ship)#542
Merged
docs: surface mentions for temporal-validity (post-RFC ship)#542
Conversation
Temporal-validity RFC v1 shipped all 7 goals on main 2026-04-29 (#533/#534/#538/#539/#540), but the implementation PRs deliberately deferred user-facing docs because (a) the feature is opt-in via frontmatter — users don't encounter ``as_of`` until they edit — and (b) PROMOTION-CRITERIA #1 ("no breaking changes for at least 2 release cycles or 1 minor version bump") is not yet met for a full standalone guide. This adds the *minimum* surface mentions per ``feedback_doc_update_process.md`` (new CLI flag / MCP tool param need same-PR reference doc), without inflating into a conceptual guide. Comprehensive explanation lives in private docs and gets promoted to ``docs/guides/temporal-validity.md`` after one minor version bump and a source-of-truth audit. Surface mentions: - ``docs/guides/reference.md`` ``mem_search`` parameters table: one row for ``as_of`` covering format (``YYYY-MM-DD`` / ``YYYY-QN``), default semantics, and opt-in behavior. - ``docs/guides/reference.md`` ``mem_search`` examples: one historical-query example. - ``docs/guides/reference.md`` post-rerank result-count contract blockquote, parallel to the existing ``source_filter`` / ``tag_filter`` shrinkage caveat (verbatim from the ``mem_search`` docstring). - ``docs/guides/reference.md`` CLI quick-reference: one ``mm search --as-of`` line + a ``mm recall`` Validity-column parenthetical. - ``docs/guides/mcp-clients.md`` tool inventory: ``mem_search`` row gains an ``optional as_of for temporal-validity queries`` parenthetical (matches the abstraction level of the rest of the row). ``README.md`` and ``packages/memtomem/README.md`` features lists deliberately not touched — those bullets are positioning at the "what is memtomem" level, and a per-parameter mention would be out of scale. Will be revisited if temporal-validity becomes a positioning differentiator after the v2 supersession layer lands. Source-of-truth verification (per ``feedback_docs_as_tests.md``): - ``mem_search(as_of=...)`` → ``packages/memtomem/src/memtomem/server/tools/search.py:38`` - ``mm search --as-of`` → ``packages/memtomem/src/memtomem/cli/search.py:22`` - ``mm recall`` Validity column (conditional) → ``packages/memtomem/src/memtomem/cli/memory.py:163-179`` - Result-count contract wording matches the docstring at ``server/tools/search.py:65-68`` verbatim. Co-Authored-By: Claude <[email protected]>
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary
Temporal-validity RFC v1 shipped all 7 goals on
main(#533/#534/#538/#539/#540), but the implementation PRs deliberately deferred user-facing docs. This adds the minimum surface mentions required byfeedback_doc_update_process.md— new MCP tool param + new CLI flag should ship with same-PR reference docs.The comprehensive conceptual guide is not in this PR. It lives in the private
memtomem-docsrepo and gets promoted todocs/guides/temporal-validity.mdafter one minor version bump (PROMOTION-CRITERIA #1) and a source-of-truth audit. This PR is the in-the-meantime reference touch only.Why now (and not in #538/#539/#540)
The feature is opt-in via frontmatter — users do not encounter
as_ofuntil they explicitly addvalid_from/valid_toto a chunk. So shipping the surface PRs without same-PR docs did not break any user's expectations. Butfeedback_doc_update_process.mdsays new CLI/MCP surface should be discoverable inreference.md/mcp-clients.md, so this is the catch-up.Scope
docs/guides/reference.md:mem_searchparameters table → oneas_ofrow (format, default, opt-in semantics)mem_searchexamples → one historical-query exampleserver/tools/search.pydocstring (parallels existingsource_filter/tag_filtercaveat shape)mm search --as-ofline + amm recallValidity-column parentheticaldocs/guides/mcp-clients.md:mem_searchrow →(... optional as_of for temporal-validity queries)parentheticalREADME.md/packages/memtomem/README.mdKey Features bullets intentionally left untouched — they sit at the "what is memtomem" abstraction level, and a per-parameter mention would be out of scale. Revisit if temporal-validity grows into a positioning differentiator after the v2 supersession layer.Source-of-truth verification (per
feedback_docs_as_tests.md)mem_search(as_of=...)packages/memtomem/src/memtomem/server/tools/search.py:38mm search --as-ofpackages/memtomem/src/memtomem/cli/search.py:22mm recallValidity column (conditional)packages/memtomem/src/memtomem/cli/memory.py:163-179server/tools/search.py:65-68verbatimYYYY-MM-DD/YYYY-QN_parse_validity_boundaccepts both shapesTest plan
docs/guides/reference.mdand confirmas_ofrow reads cleanly inside the existing parameter tabledocs/guides/mcp-clients.mdand confirm themem_searchcell does not overflow visually with the added parentheticalmm search --as-of 2024-Q3 "deploy"in the CLI quick-reference matches the actual--as-offlag (already verified in source check above)🤖 Generated with Claude Code