diff --git a/docs/release/trg-1/trg-1-1.md b/docs/release/trg-1/trg-1-1.md index 5865afc02a8..8327657fbd8 100644 --- a/docs/release/trg-1/trg-1-1.md +++ b/docs/release/trg-1/trg-1-1.md @@ -30,7 +30,7 @@ Each repository **must** contain a `README.md` file which **shall** cover follow Best practices: - If installation instructions for your product are too complex being part of `README.md` move its content to a separate `INSTALL.md` file, see [TRG 1.02](trg-1-2.md). -- If your project is too complex to be described in a single `README.md` file, consider creating a `docs` folder and link your `README.md` to it. +- If your project is too complex to be described in a single `README.md` file, it may be beneficial to relocate specific sections to a dedicated `docs/` folder. - If your project has multiple component repositories (e.g. frontend and backend), link the other repositories in your leading repository in your `README.md` mutually. In summary, a good README is a crucial component of any repository, serving as a gateway for users and contributors to understand, use, and potentially contribute to your project. It's a fundamental part of effective project communication and collaboration.