Repository navigation
docs: improve OpenTenBase introduction in quick start - #72
Open
niniland369 wants to merge 1 commit into
Open
niniland369 wants to merge 1 commit into
niniland369 wants to merge 1 commit into
Conversation
Split the long opening paragraph, explain distributed/replicated with in-repo references, clarify the CN to DN query path, and align the wording with the English version. No technical meaning changed.
This branch has not been deployed
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.
改动内容
优化「快速入门 → 什么是 OpenTenBase」引言段的表达:拆分长句、补齐术语解释、明确 CN/DN 的查询链路、消除与英文版及本站其他文档的不一致。
docs/guide/01-quickstart.md修改动机
该段是全站新手最先读到的文字,原文存在:
distributed/replicated裸抛且无解释,与03-basic-use.md的「分片表 / 复制表」叫法不一致;multi node不符。技术依据(均为仓库内)
01-quickstart.md:13-1903-basic-use.md:16distribute by replication:03-basic-use.md:104, 112, 14301-quickstart.en.md:5验证
docs/contribution/docs-format-guide.md完成格式自检03-basic-use.md已确认存在mkdocs build生成的页面中,改写段落与链接../03-basic-use/均正确渲染备注
「写可靠性」在仓库内暂无进一步定义,本次保留原词未作解释,建议后续补充。