innerr/ticat

Doc: need a thorough improvement

Opened this issue · 1 comments

Grammar and spelling fixing:

The first author of these docs is not native English writer, so there are lots of errors on these docs need to be fixed.

Better organization in info layers

There are 3 types of docs:

  • For common users
  • For module developers
  • For ticat contributers

Each type of docs need 3 layers (some types need less layers):

  • Quick start
  • Common usage
  • Detailed specs

So, a sophisticated info revealing is needed.

For now we have a rough skeleton not totally bad, but some infos need to adjust between layers.

Have a big lag from doc and implementing now, this should improve