innerr / ticat

A lightweight command line components platform
Apache License 2.0
25 stars 6 forks source link

Doc: need a thorough improvement #17

Open innerr opened 3 years ago

innerr commented 3 years ago

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:

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

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.

innerr commented 2 years ago

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