[docs] Reorganized and cleaned up the docs folder (Haivision#1911)

Author: mbakholdina

CONTRIBUTING.md

@@ -21,7 +21,7 @@ Submit a pull request at any time, whether an issue has been created or not. It
 * SRT protocol definitions
 * portability and platform-specific parts
 
-Please follow the [Developer's guide](./docs/DevelopersGuide.md).
+Please follow the [SRT Developer's Guide](docs/dev/developers-guide.md).
 
 ## Code Style
 

README.md

@@ -34,14 +34,14 @@ As audio/video packets are streamed from a source to a destination device, SRT d
 ### Guides
 
 * [SRT API Documents](docs/API/)
-* [Using the `srt-live-transmit` App](docs/srt-live-transmit.md)
-* [Developer's Guide](docs/DevelopersGuide.md)
+* [Using the `srt-live-transmit` App](docs/apps/srt-live-transmit.md)
+* [SRT Developer's Guide](docs/dev/developers-guide.md)
 * [Contributing](CONTRIBUTING.md)
-* [Reporting problems](docs/reporting.md)
+* [Reporting Issues](docs/dev/making-srt-better.md)
 * SRT RFC: [Latest IETF Draft](https://datatracker.ietf.org/doc/html/draft-sharabayko-srt-00), [Latest Working Copy](https://haivision.github.io/srt-rfc/draft-sharabayko-srt.html), [GitHub Repo](https://github.com/Haivision/srt-rfc)
 * SRT CookBook: [Website](https://srtlab.github.io/srt-cookbook), [GitHub Repo](https://github.com/SRTLab/srt-cookbook)
 * [SRT Protocol Technical Overview](https://github.com/Haivision/srt/files/2489142/SRT_Protocol_TechnicalOverview_DRAFT_2018-10-17.pdf)
-* [Why SRT Was Created](docs/why-srt-was-created.md)
+* [Why SRT Was Created](docs/misc/why-srt-was-created.md)
 
 ## Requirements
 
@@ -50,7 +50,7 @@ As audio/video packets are streamed from a source to a destination device, SRT d
 * OpenSSL
 * Pthreads (for POSIX systems it's builtin, for Windows there's a library)
 
-For detailed description of the build system and options, please read [BuildOptions.md](docs/BuildOptions.md).
+For detailed description of the build system and options, please read [SRT Build Options](docs/build/build-options.md).
 
 ### Build on Linux
 
@@ -127,7 +127,7 @@ make
 
 ### Build on Windows
 
-Follow the [Windows build instructions](docs/build-win.md).
+Follow the [Building SRT for Windows](docs/build/build-win.md) instructions.
 
 [appveyor-badge]: https://img.shields.io/appveyor/ci/Haivision/srt/master.svg?label=Windows
 [appveyor]: https://ci.appveyor.com/project/Haivision/srt

docs/API/API-functions.md

@@ -1507,7 +1507,7 @@ The following options are allowed to be set on the member socket:
 * [srt_setsockopt, srt_setsockflag](#srt_setsockopt-srt_setsockflag)
 * [srt_getversion](#srt_getversion)
 
-**NOTE**: For more information, see [Getting and Setting Options](API-socket-options.md#getting-and-setting-options).
+**NOTE**: For more information, see [SRT API Socket Options, Getting and Setting Options](API-socket-options.md#getting-and-setting-options).
 
 ### srt_getpeername
 ```
@@ -1732,8 +1732,8 @@ call [`srt_sendmsg2`](#srt_sendmsg) or [`srt_recvmsg2`](#srt_recvmsg2) function
 for a group, you should pass an array here so that you can retrieve the status of 
 particular member sockets. If you pass an array that is too small, your `grpdata_size` 
 field will be rewritten with the current number of members, but without filling in 
-the array. For details, see the (Bonding introduction)[../bonding-intro.md] and 
-(Socket Groups)[../socket-groups.md] documents.
+the array. For details, see the [SRT Connection Bonding](../features/bonding-intro.md) and 
+[SRT Socket Groups](../features/socket-groups.md) documents.
 
 **Helpers for [`SRT_MSGCTRL`](#SRT_MSGCTRL):**
 

docs/API/API-socket-options.md

@@ -796,7 +796,7 @@ complete (not all packets received or there was a packet loss) it will not be
 copied to the application's buffer. Messages that are sent later, but were
 earlier reassembled by the receiver, will be delivered once ready, if the
 `inorder` flag was set to false.
-See [`srt_sendmsg`](API.md#sending-and-receiving)).
+See [`srt_sendmsg`](API.md#sending-and-receiving).
 
 As a comparison to the standard system protocols, the Stream API does
 transmission similar to TCP, whereas the Message API functions like the
@@ -920,7 +920,7 @@ The connection will be rejected with `SRT_REJ_FILTER` code in the following case
 In case of the built-in `fec` filter, the mandatory parameter is `cols`, all
 others have their default values. For example, the configuration specified
 as `fec,cols:10` is `fec,cols:10,rows:1,arq:onreq,layout:even`. See how to
-[configure the FEC Filter](packet-filtering-and-fec.md#configuring-the-fec-filter).
+configure the FEC filter in [SRT Packet Filtering & FEC](../features/packet-filtering-and-fec.md#configuring-the-fec-filter).
 
 Below in the table are examples for the built-in `fec` filter. Note that the
 negotiated config need not have parameters in the given order.
@@ -950,7 +950,7 @@ Reading this option after the connection is established will return the full
 configuration that has been agreed upon by both parties (including default
 values).
 
-For details, see [Packet Filtering & FEC](packet-filtering-and-fec.md).
+For details, see [SRT Packet Filtering & FEC](../features/packet-filtering-and-fec.md).
 
 [Return to list](#list-of-options)
 
@@ -1455,7 +1455,7 @@ will be able to retrieve this stream ID from the socket that is returned from
 `srt_accept` (for a connected socket with that stream ID). You usually use SET 
 on the socket used for `srt_connect`, and GET on the socket retrieved from 
 `srt_accept`. This string can be used completely free-form. However, it's highly 
-recommended to follow the [SRT Access Control guidlines](../AccessControl.md).
+recommended to follow the [SRT Access Control (Stream ID) Guidlines](../features/access-control.md).
 
 - As this uses internally the `std::string` type, there are additional functions
 for it in the legacy/C++ API (udt.h): `srt::setstreamid` and `srt::getstreamid`.

docs/API/API.md

@@ -281,7 +281,7 @@ nb = srt_recvmsg2(u, buf, nb, &mc);
 ### Transmission Types Available in SRT
 
 Mode settings determine how the sender and receiver functions work. The main
-[socket options](API-socket-options.md) that control it are:
+SRT [socket options](API-socket-options.md) that control it are:
 
 - `SRTO_TRANSTYPE`. Sets several parameters in accordance with the selected
 mode:
@@ -519,7 +519,7 @@ either `FASTREXMIT` or `LATEREXMIT`. This will be explained below.
 
 ### Transmission Method: Live
 
-Setting `SRTO_TRANSTYPE` to `SRTT_LIVE` sets the following [parameters](API-socket-options.md):
+Setting `SRTO_TRANSTYPE` to `SRTT_LIVE` sets the following [socket options](API-socket-options.md):
 
 - `SRTO_TSBPDMODE` = true
 - `SRTO_RCVLATENCY` = 120
@@ -596,7 +596,7 @@ NAKREPORT method is considered so effective that FASTREXMIT isn't necessary.
 
 ### Transmission Method: Buffer
 
-Setting `SRTO_TRANSTYPE` to `SRTT_FILE` sets the following [parameters](API-socket-options.md):
+Setting `SRTO_TRANSTYPE` to `SRTT_FILE` sets the following [socket options](API-socket-options.md):
 
 - `SRTO_TSBPDMODE` = false
 - `SRTO_RCVLATENCY` = 0

docs/API/statistics.md

@@ -246,29 +246,29 @@ The total number of packets that failed to be decrypted at the receiver side. Av
 
 #### pktSndFilterExtraTotal
 
-The total number of packet filter control packets generated by the packet filter (refer to [SRT Packet Filtering & FEC](../packet-filtering-and-fec.md)). Available for sender.
+The total number of packet filter control packets generated by the packet filter (refer to [SRT Packet Filtering & FEC](../features/packet-filtering-and-fec.md)). Available for sender.
 
 Packet filter control packets contain only control information necessary for the packet filter. The type of these packets is DATA.
 
 If the `SRTO_PACKETFILTER` socket option is disabled (refer to [SRT API Socket Options](API-socket-options.md)), this statistic is equal to 0. Introduced in SRT v1.4.0.
 
 #### pktRcvFilterExtraTotal
 
-The total number of packet filter control packets received by the packet filter (refer to [SRT Packet Filtering & FEC](../packet-filtering-and-fec.md)). Available for receiver.
+The total number of packet filter control packets received by the packet filter (refer to [SRT Packet Filtering & FEC](../features/packet-filtering-and-fec.md)). Available for receiver.
 
 Packet filter control packets contain only control information necessary for the packet filter. The type of these packets is DATA.
 
 If the `SRTO_PACKETFILTER` socket option is disabled (refer to [SRT API Socket Options](API-socket-options.md)), this statistic is equal to 0. Introduced in SRT v1.4.0.
 
 #### pktRcvFilterSupplyTotal
 
-The total number of lost DATA packets recovered by the packet filter at the receiver side (e.g., FEC rebuilt packets; refer to [SRT Packet Filtering & FEC](../packet-filtering-and-fec.md)). Available for receiver.
+The total number of lost DATA packets recovered by the packet filter at the receiver side (e.g., FEC rebuilt packets; refer to [SRT Packet Filtering & FEC](../features/packet-filtering-and-fec.md)). Available for receiver.
 
 If the `SRTO_PACKETFILTER` socket option is disabled (refer to [SRT API Socket Options](API-socket-options.md)), this statistic is equal to 0. Introduced in SRT v1.4.0.
 
 #### pktRcvFilterLossTotal
 
-The total number of lost DATA packets **not** recovered by the packet filter at the receiver side (refer to [SRT Packet Filtering & FEC](../packet-filtering-and-fec.md)). Available for receiver.
+The total number of lost DATA packets **not** recovered by the packet filter at the receiver side (refer to [SRT Packet Filtering & FEC](../features/packet-filtering-and-fec.md)). Available for receiver.
 
 If the `SRTO_PACKETFILTER` socket option is disabled (refer to [SRT API Socket Options](API-socket-options.md)), this statistic is equal to 0. Introduced in SRT v1.4.0.
 
@@ -363,25 +363,25 @@ Same as [pktRecvNAKTotal](#pktRecvNAKTotal), but for a specified interval.
 
 Same as [pktSndFilterExtraTotal](#pktSndFilterExtraTotal), but for a specified interval.
 
-Introduced in v1.4.0. Refer to [SRT Packet Filtering & FEC](../packet-filtering-and-fec.md).
+Introduced in v1.4.0. Refer to [SRT Packet Filtering & FEC](../features/packet-filtering-and-fec.md).
 
 #### pktRcvFilterExtra
 
 Same as [pktRcvFilterExtraTotal](#pktRcvFilterExtraTotal), but for a specified interval.
 
-Introduced in v1.4.0. Refer to [SRT Packet Filtering & FEC](../packet-filtering-and-fec.md).
+Introduced in v1.4.0. Refer to [SRT Packet Filtering & FEC](../features/packet-filtering-and-fec.md).
 
 #### pktRcvFilterSupply
 
 Same as [pktRcvFilterSupplyTotal](#pktRcvFilterSupplyTotal), but for a specified interval.
 
-Introduced in v1.4.0. Refer to [SRT Packet Filtering & FEC](../packet-filtering-and-fec.md).
+Introduced in v1.4.0. Refer to [SRT Packet Filtering & FEC](../features/packet-filtering-and-fec.md).
 
 #### pktRcvFilterLoss
 
 Same as [pktRcvFilterLossTotal](#pktRcvFilterLossTotal), but for a specified interval.
 
-Introduced in v1.4.0. Refer to [SRT Packet Filtering & FEC](../packet-filtering-and-fec.md).
+Introduced in v1.4.0. Refer to [SRT Packet Filtering & FEC](../features/packet-filtering-and-fec.md).
 
 #### mbpsSendRate
 
@@ -727,12 +727,12 @@ that is received late.
 
 SRT group statistics are implemented for SRT Connection Bonding feature and available since SRT v1.5.0. Check the following documentation and code examples for details:
 
-- [Introduction in SRT Connection Bonding feature](../bonding-intro.md),
-- [The concept of socket groups](../socket-groups.md). Here you will also find the information regarding `srt-test-live`  application for testing Connection Bonding,
+- Introduction in [SRT Connection Bonding](../features/bonding-intro.md),
+- The concept of [SRT Socket Groups](../features/socket-groups.md). Here you will also find the information regarding the `srt-test-live` application for testing Connection Bonding,
 - Check also [SRT API](API.md) and [SRT API Functions](API-functions.md) documentation for Connection Bonding related updates,
 - Code examples: simple [client](https://github.com/Haivision/srt/blob/master/examples/test-c-client-bonding.c) and [server](https://github.com/Haivision/srt/blob/master/examples/test-c-server-bonding.c) implementation.
 
-`srt_bistats(SRTSOCKET u, ...)`  function can be used with a socket group ID as a first argument to get statistics for a group. Most values of the `SRT_TRACEBSTATS` will be filled with zeros except for the fields listed in [Summary Table](#group-summary-table) below. Refer to the documentation of the [API functions](API-functions.md) for usage instructions.
+`srt_bistats(SRTSOCKET u, ...)`  function can be used with a socket group ID as a first argument to get statistics for a group. Most values of the `SRT_TRACEBSTATS` will be filled with zeros except for the fields listed in [Summary Table](#group-summary-table) below. Refer to the documentation of the [SRT API Functions](API-functions.md) for usage instructions.
 
 ### Summary Table <a name="group-summary-table"></a>