#492 docs: add an index page for docs/

[Anonymous]

Originally created by: navaneethsankar07

Summary

• Added docs/README.md as an index for the documentation.
• Included a short description for each document explaining when to open it.
• Kept the descriptions based on each document's opening section.

Note

The current docs/ directory contains additional documentation files beyond the eight referenced in the issue. I kept this PR scoped to the eight documents mentioned in the issue.

Closes [#409]

[Anonymous]

Ticket changed by: fu351

• status: open --> closed

[Anonymous]

Originally posted by: fu351

Merged, thanks @navaneethsankar07! Writing each line as "open this when…" from the doc's own opening is what makes the table useful, a newcomer can pick a file without opening any of them. Good call scoping to the eight the issue named and saying so. If you want to finish the job, docs/ has grown five files since the issue was written (PLUGINS, RECOVERY, TELEMETRY, TUNING, TURN_GATE), and a follow-up PR adding a row for each in the same table would be very welcome, no issue needed, just open it and I'll review. If you have questions the Discord is here: https://discord.gg/Sfy5XGNqty

[Anonymous]

Originally posted by: navaneethsankar07

Thanks! I’ve opened a follow-up PR adding the five new docs to the index.