docs: add search_filter + tags scoping guide and deployment/scaling notes (#386, follow-up to #402) - #404
Open
RerankerGuo wants to merge 1 commit into
Open
Conversation
…orizontal-scaling notes
Documents two features that already landed in code but lacked user-facing docs:
1. memory_search.md - Search Filters (search_filter)
- Documents the structured pre-scoring filter API: path/paths/prefix/date/
metadata/tags, including each key's type and semantics
- Dedicated multi-user / multi-profile scoping walk-through showing
containment-style AND tags filter end-to-end: frontmatter tags at write
time, CLI usage, and MCP/HTTP tool body JSON example
- Lists the semantic rules (AND containment, CSV accepted, scalar tags
supported, untagged files default to visible) so plugin authors can
rely on them
- References sibling plugins (Claude Code / Codex / OpenClaw / QwenPaw /
Hermes Agent) as the primary consumers of this pattern
2. deployments_and_scaling.md (new page)
- Restates the two non-negotiable design invariants: files as source of
truth, human-readable surface preserved
- ASCII diagram of the default single-process/single-machine topology
- Archives the exact maintainer position from agentscope-ai#386: "not on official
roadmap today, explicitly welcome as community components" so future
contributors have one stable reference instead of re-asking in every
new scaling issue
- Three low-op-ex isolation recipes: per-user workspaces, tags scoping,
hybrid (shared digest + private daily/ with tags)
- Contribution guide for community backend PRs: sharp boundary, rebuild
CLI, single-process default preserved, Hydra config, pre-PR design
discussion
- Failure-modes table covering the ReMe-specific footguns (external
index only, double auto_memory, NFS writers, SIGKILL teardown, etc.)
Related issues: agentscope-ai#386 (horizontal scaling guidance), agentscope-ai#402 (tags filter impl).
No code changes; zero impact on runtime behavior.
Contributor
|
Caution The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased. |
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
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.
背景
代码已经在之前的两个 PR 中落地:
search_filter["tags"]containment-style AND filter 的完整代码逻辑 + 单元测试但目前用户/插件作者缺少一份结构化的使用说明:
search_filter是 ReMe 最核心的搜索过滤接口,包含 6 个 key,但 memory_search.md 只讲了打分逻辑,没有任何 filter 文档,导致用户只能看源码或 Issue 评论才能正确使用。改动内容
1.
docs/en/memory_search.md— 新增 Search Filters 章节(接 #402)在原文末尾追加约 80 行文档:
search_filter):整体介绍 + YAML 示例path/paths/prefix/date/metadata/tags),逐一说明类型和语义tags:端到端实战指南tags: [user:alice, conv:xxx])search工具 JSON body 示例2.
docs/en/deployments_and_scaling.md— 新建部署与横向扩展指南(接 #386)全新文档页,约 250 行,结构清晰分 6 节:
tagsscoping(与 feat(search): add containment-style tags filter for multi-user scoping (#368) #402 互文引用)验证方式
pre_commit run --files docs/en/memory_search.md docs/en/deployments_and_scaling.md→ 12/12 hooks 通过(trim-whitespace、private-key、pyroma 等)。pytest tests/unit -x -q→ 858 passed,零回归(docs 改动不影响运行时)。影响范围
memory_search.md是 ReMe 核心文档页之一,追加章节后读者可以原地理解 search_filters,无需跳转到源码。deployments_and_scaling.md是全新文档页,后续可在 quick_start.md 的 "进一步阅读" 或框架总览中添加链接(本轮暂不加,避免大范围修改引起额外 review 负担 — 后续单独 tiny PR 跟进即可)。Checklist