Research in detail about `<GenerateReadMe/ >` and `GenerateReadMe()`

Ok so we figure out why the ``
was not working originally in thread - https://asyncapi.slack.com/archives/C072JMTJ85Q/p1763650533905419

So actually `GenerateReadMe()` is also correct but we need document that if a component return `` component you need to use like `GenerateReadMe()` otherwise you can call ``.

cc @derberg wdyt 🤔? @thulieblack for now don't change anything around this usage of "GenerateReadMe" let's first discuss and document so that similar issue can be avoided in future.

_Originally posted by @Adi-204 in https://github.com/asyncapi/generator/pull/1725#discussion_r2578324443_

No documentation file or test is named. Start by reviewing the linked Slack thread and the GenerateReadMe discussion in pull request #1725 to confirm the two usage cases. Done means documenting when to use GenerateReadMe() versus based on whether the component returns .

Written by the indexing model from the issue text.