Skip to content

Optimize the Document Structure #169

@faweizhao26

Description

@faweizhao26

Here are our current official documents: https://docs.ivorysql.org/cn/ivorysql-doc/master/welcome

Here is the optimized document structure we finalized after multiple rounds of discussion: https://www.kdocs.cn/l/cg7tqtbtTXYB

The parts marked in red are exactly the document tasks for this activity, including two major types: new documents (needing to be written) and optimization.

However, in addition to the document content itself, we also hope to continuously optimize the document structure:

  • Add content missing from the documents (e.g., previously missing IvorySQL performance tuning documents)
  • Adjust the current order of the document directory (e.g., adjust the existing order of documents)
  • ......

优化文档结构

这是我们目前官网上的文档:https://docs.ivorysql.org/cn/ivorysql-doc/master/welcome

这是我们在商讨多轮后优化的文档结构:https://www.kdoc s.cn/l/cg7tqtbtTXYB

标注红色的部分,正是本次活动的文档任务,包括新增(需要撰写)和优化两大类型。

不过,除了文档内容本身,我们也希望能够持续优化文档的结构:

  • 增加文档缺少的内容(比如之前缺少 IvorySQL 性能调优的文档)
  • 文档目录结构调整(比如文档目前顺序调整)
  • ......

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions