From 383ab5cdf294e002801ed5be8194f43cdf8b3d25 Mon Sep 17 00:00:00 2001 From: Donat Zenichev Date: Fri, 21 Apr 2023 11:56:56 +0200 Subject: [PATCH] MT#55897 Fix links in the `README.md` / `overview.md` It's been noticed that quick access links in the general `overview.md` of the RTD are broken, they simply don't see needed files, since these links were implemented for the github usage initially. Because the `overview.md` is just a symlink to the `README.md` (used by the github), it's impossible to have own links (to the github files) for the `README.md` and own links for the `overview.md` in the RTD. Keeping separate files for RTD and github's README would be bad idea, since then we have to manually keep them synced. Instead, this commit proposes the solution like this: - have same quick access links for the RTD and the Github - by clicking quick access links in the github, one will be sent to the RTD article. It's a compromise solution, which gives us working access by both github and RTD. Then, in order to access github doc files, one has to enter the `docs/` folder and select a needed one. Change-Id: Ic58437dccbdccd8289e8282fcf8e91c71057e366 --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 377f937bd..1d5c99c98 100644 --- a/README.md +++ b/README.md @@ -78,21 +78,21 @@ replacement for *Janus* using the native Janus control protocol (see below). Check our general documentation here: * [Read-the-Docs](https://rtpengine.readthedocs.io/en/latest/) -Documentation stored in the GitHub (for usage): -* [Compiling and Installing](docs/compiling_and_installing.md) -* [Usage](docs/usage.md) -* [Transcoding](docs/transcoding.md) -* [Call recording](docs/call_recording.md) -* [The NG Control Protocol](docs/ng_control_protocol.md) -* [The TCP-NG Control Protocol](docs/tcpng_control_protocol.md) -* [HTTP/WebSocket support](docs/http_websocket_support.md) -* [Janus Interface and Replacement Functionality](docs/janus_interface_and_replacement.md) - -Documentation stored in the GitHub (for development): -* [Architecture Overview](docs/architecture.md) -* [Unit-tests](docs/tests.md) -* [Troubleshooting Overview](docs/troubleshooting.md) -* [Glossary](docs/glossary.md) +For quick access, documentation for usage: +* [Compiling and Installing](https://rtpengine.readthedocs.io/en/latest/compiling_and_installing.html) +* [Usage](https://rtpengine.readthedocs.io/en/latest/usage.html) +* [Transcoding](https://rtpengine.readthedocs.io/en/latest/transcoding.html) +* [Call recording](https://rtpengine.readthedocs.io/en/latest/call_recording.html) +* [The NG Control Protocol](https://rtpengine.readthedocs.io/en/latest/ng_control_protocol.html) +* [The TCP-NG Control Protocol](https://rtpengine.readthedocs.io/en/latest/tcpng_control_protocol.html) +* [HTTP/WebSocket support](https://rtpengine.readthedocs.io/en/latest/http_websocket_support.html) +* [Janus Interface and Replacement Functionality](https://rtpengine.readthedocs.io/en/latest/janus_interface_and_replacement.html) + +For quick access, documentation for development: +* [Architecture Overview](https://rtpengine.readthedocs.io/en/latest/architecture.html) +* [Unit-tests](https://rtpengine.readthedocs.io/en/latest/tests.html) +* [Troubleshooting Overview](https://rtpengine.readthedocs.io/en/latest/troubleshooting.html) +* [Glossary](https://rtpengine.readthedocs.io/en/latest/glossary.html) # Contribution