Align the sharding guide route with its public terminology

未关闭 适合新手
#768 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 4 天内回复

还没有人认领这个 Issue。

评估

难度
1/5
预计耗时
1 小时以内
新手友好度
76/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
活跃
技术栈
markdown
领域
documentation

调研方向

从 reference/replication/residency.md 开始,阅读链接的 PR #753 源码,以识别现有的指南路由以及它应匹配的公开指令术语。编辑前先在 docs 中搜索对该路由的其他引用,然后一致地更新路由和措辞。完成意味着指南使用公开术语,且不再残留过时的路由引用。

由索引模型根据 Issue 内容生成。

描述

Deferred from the closing review of #753 for declarative sharding (Pro #980). The owner explicitly scoped this root cause out of the closing implementation batch.

Current assessment: The existing residency guide route is valid; renaming it to match the public directive is editorial cleanup.

Owning path: reference/replication/residency.md. Review lines move as the companion branches integrate main; use the linked PR's current source.

Follow-up: Implement and verify the scoped documentation or test improvement without expanding the current runtime contract.

This issue does not reopen #980's approved primary-key-only scope, complete-history requirement, or ban on write serialization. It does not block the current drafts. No release or backport is committed; milestone is intentionally unset. Found through source review and synthetic tests; there is no customer-specific incident evidence.

Triage: P3; effort Low; type Task. Low-priority follow-up: no demonstrated correctness failure or new release requirement. This is deliberately below the parent reliability priority.

Finding IDs: e2cd859b21ae, 68c9d5e35b37.

Review-Deferral: 4988dd48aee75b40 severity=nit category=documentation

Review-Deferral: 1dacd324d46b97cd severity=nit category=documentation

🤖 Generated by OpenAI Codex; posted via @kriszyp.

主要语言
MDX
星标
9
派生
9
平均合并
5 天 5 小时
30 天内合并 PR
48

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

HarperFast/documentation 的其他 Issue

查看 HarperFast/documentation 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。