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

[Adi-204]

Ok so we figure out why the <GenerateReadMe/ >
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 <File/> component you need to use like GenerateReadMe() otherwise you can call <GenerateReadMe/ >.

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 #1725 (comment)

[lightning-sagar]

hi @Adi-204
i understand the context behind this now..
could you please guide me on where exactly this behavior should be documented (which doc section would be the best place)?

i also had a couple of questions for discussion (not suggesting changes right away)->

• would it be possible to throw a warning if a component returning <File /> is used via JSX?
• or could the generator auto-detect <File /> returns and handle it gracefully?

for now, I agree we should document first so similar issues can be avoided in the future...