I have some suggestions. * Change the documents step by step. We need to keep the old materials available only when we are sure the material can be deleted and useless. We can doing this by adding new materials, move or refactor old materials to fit your TOC step by step. * Do NOT change the whole content in one big refactor. And your suggested TOC is quite different with the current one, I cannot say it is good or not, no one can verify this. * Do it now by make small changes to current docs, we can check if it is better in progress.
-----邮件原件----- 发件人: victor chan [mailto:victorchan...@gmail.com] 发送时间: 2019年11月28日 14:26 收件人: yhs0092 <dev@servicecomb.apache.org> 主题: [DISCUSSION] [Website] Reorganize official website documents Based on feedback from previous users, I planned a document improvement structure. like this, Documentation ├── Getting Started Guide (for indexing and learning process guidance only) │ ├── Platform installation │ ├── Entry project │ ├── Advanced Project │ └── Solutions │ ├── Project A │ ├── Project introduction │ │ ├── What is it, what is solved │ │ ├── Architecture analysis │ │ └── Function introduction │ ├── Quick start (only the simplest introduction) │ ├── Detailed function (combination example) │ │ ├── Create from zero │ │ ├── Function 1 │ │ ├── Function 2 │ │ └── Function ... │ ├── API / configuration query manual │ ├── Efficiency tool (combined with reality) │ │ ├── Tool A │ │ ├── Tool B │ │ └── Tool ... │ ├── Experience reference (According to actual output, the following is hypothetical content) │ │ ├── Performance testing and tuning │ │ ├── Suggestion for the production environment (function enablement, upgrade plan, etc.) │ │ ├── Troubleshooting │ │ └── FAQ │ ├── Development Guide │ │ ├── Build from source code │ │ ├── Module design │ │ ├── Module A source code analysis │ │ ├── Module B source code analysis │ │ ├── Module ... source code analysis │ │ ├── Coding conventions │ │ └── Test case guidance │ └── Operation and Maintenance Guide │ ├── Management page introduction │ ├── Function A │ ├── Function B │ └── Function ... │ └── Project ... └── ... Do you have any thoughts?
