Rework documentation

[romanzaycev]

Currently, the documentation for the main ton component is not very easy to learn.

We need to:

• move Markdown files of documentation to a separate docs/ directory;
• separate the description of each class into a separate Markdown file;
• make a link to the documentation section from the root README.

[jchansen925]

Hi Roman, I'd be happy to assist you with this task. I'm a developer and technical writer. You can assign this to me if you'd like.

Thanks, John Hansen john.hansenux@gmail.com

[jchansen925]

I was not able to find the markdown files, just the README. If you have further directions please let me know. Thanks.

[romanzaycev]

@jchansen925, hello!

The task is to create separate documentation. Now everything is described in one README.md.

I think that we need a separate directory (docs) with INDEX.md file and separate documents: installation.md, tonecenter.md and so on. The current README content needs to be transferred to these new documents.

This will be the skeleton for further development of the documentation.

--

You can also pay attention to this issue: https://github.com/olifanton/interop/issues/1 It is also taking place as part of Hack-Ton-Berfest.

[jchansen925]

@romanzaycev

Hi Roman, thank you for the clarification. This makes sense now. I'll start on the first task today and then look at the second.

John