Clean up documentation and get it aligned with the application(s)

[noseshimself]

As a complete newbie I have serious problems with the precision of the available documentation. It starts with https://openziti.github.io/docs/introduction/intro/ -- that diagram is (showing "Router"s, an element that never shows up in documentation by that name, edge routers and applications communicating with some API.

[I would bet the majority of the users today are at least a few miles away from that concept; they are (like me) looking for some kind of overlay network connecting their systems that are connected to the internet by various means, sometimes behind three layers of carrier-grade NAT and needing access to systems hosted somewhere else. Single applications are the smallest of their problems.]

Now you are going on about the Controller (that, as soon as you want to install it, miraculously is also called an "edge-controller" in the docker-compose (I didn't try anything else) as it turns out to be a zitified application needing an edge-router to be able to work at all. Next are fabric and edge router and to this day I don't get it -- is an edge router a fabric router with additional capabilities or a totally different thing. And why can all of it be in one all-in-one docker image? Edge client. Connects to the edge router but what exactly is it? The equivalent to a VPN client or rather some API for some applications? Is an entire OS a "unaware application" that requires a tunneler for pushing all the traffic between what others would call "nodes" across the network?

The only thing that will help here is mapping "user expectations in regards to terminology" onto your way of expressing things and showing examples for some more standard architectural patterns Ziti can be used to implement from typical mesh-VPN to IoT communications.

As good as the whole package is and as great as all of the unique ideas in there are (most products really stop at the mesh-VPN stage and don't add applications into the concept at all) the documentation really needs to become a focus right now. The example docker-compose configuration is not helpful for the general case (deploy one controller that is not bundled with anything else like red, blue or purple networks (these definitely belong somewhere else). Explain the set-up of a mesh and the concept behind fabric and edge routers (and where and why they are different) and their separate (as in not together with the controller) deployment.