[doc] Added and updated description of useful test applications #2191
Conversation
There was a problem hiding this comment.
The "sample applications" section of the docs/README.md also needs an update then.
maxsharabayko
added
the
Type: Maintenance
|
Ok, updated, and I also added one more lacking description :) |
There was a problem hiding this comment.
Hi @ethouris, thank you for updating the documentation! A couple of minor comments from me.
docs/README.md
Outdated
| | [Using the<br /> `srt-tunnel` App](apps/srt-tunnel.md) | [apps](apps/) | [srt-tunnel.md](apps/srt-tunnel.md) | A sample application to set up an SRT tunnel for TCP traffic. | | ||
| | <img width=200px height=1px/> | <img width=100px height=1px/> | <img width=200px height=1px/> | <img width=500px height=1px/> | | ||
|
|
||
| ## Testing applications |
There was a problem hiding this comment.
There is no need to create a separate table for these 2 items. Please move everything under "Sample Applications" table and delete the current one.
There was a problem hiding this comment.
Please also change the folder to "apps" with an appropriate link.
docs/apps/srt-test-multiplex.md
Outdated
| @@ -1,26 +1,27 @@ | |||
| ## srt-multiplex | |||
| ## srt-test-multiplex | |||
There was a problem hiding this comment.
Something is wrong with the level of headings in this document. It should start with "# srt-test-multiplex" and then "## Usage", etc.. Could you please go through the document and update the levels carefully?
docs/apps/srt-test-relay.md
Outdated
| @@ -0,0 +1,34 @@ | |||
| ## srt-test-relay | |||
There was a problem hiding this comment.
Again, the level of heading is incorrect. Please change ## to #.
There was a problem hiding this comment.
I've also noticed that in srt-tunnel document the headings formatting is different. Could you please update it to look similar? Plus please change the title from "SRT Tunnel" to "srt-tunnel" for consistency. Thanks!
|
Ok, I added fixes, please check again if everything's ok |
ethouris
force-pushed
the
doc-fix-apps-descr
branch
from
eab7d3c to
f900567
Compare
srt-multiplex.md- changed tosrt-test-multiplex.mdand updatedAdded
srt-test-relay.md.