Use AI to explore XSharp (across the entire GitHub repository)

[xinjie]

Hello everyone!
China's ZhiPu AI presents https://zread.ai/. Leveraging large-model understanding, zread.ai seamlessly deconstructs entire repositories into logically coherent documentation. Whether exploring core concepts, functional modules, or API calls, it feels like reading a meticulously crafted technical book.
How to use it: In your browser's address bar, simply replace github.com with zread.ai and hit Enter! No need to copy links or switch windows—enter “God Mode” in a second.
I tested it with the XSharp project. See: https://zread.ai/X-Sharp/XSharpPublic
If you see Chinese text, just click the icon next to the small moon in the top-right corner to switch to English.
If you're really interested, click the small bell icon in the top-left corner to subscribe. This way, its content will automatically update as the repository changes.
Enjoy exploring!

[robert]

Xinjie,
This is fascinating. I find the descriptions overall very good. Is this based on the source code only, or does this include information from others sources as well?

Robert

[Irwin]

Hi xinjie,

Thanks for sharing the link. That's really amazing.

Irwin.

[xinjie]

H, Robert
The official documentation does not provide a clear explanation. Based on my experience and observations, I believe it is derived from the source file. I am unsure whether it searches based on URLs within the source file (if present).

Additionally, clicking “ASK AI” at the top of the webpage allows you to ask any questions about the repository.

Xinjie,
This is fascinating. I find the descriptions overall very good. Is this based on the source code only, or does this include information from others sources as well?

Robert

[ic2]

Although the end result it looks like a well designed documentation I don't have the impression that it actually is.
Most information is of little use for a programmer. If it would include a full explanation of each X# method including multiple samples, and the same for the compiler errors, then it would really be useful. But as far as I can see that is totally absent.

Currently I think a human with X# knowledge could enhance the current documentation with not more than a few pages with useful information not yet present in the help, by copying and pasting some parts of all which was generated. And I think that's all.

Dick

[RGreim4XS]

Hi and greetings from the Länd.

Documentation oh what a topic.... I did a lot of ASPICE in my job life.
Biggest topic, is keeping doc up to date and following all standards with syncs to requirement engineering.

That's why we automated everything we could do in a DevOps pipeline beside Doors, Jira, Confluence, IBM RTC, Polarion and many more expensive things.

And it was eco friendly with asciidoc as the base and a lot of databases (thats why I still love the XBASE language)

Have also a look at DocAsCode, Infrastructure as Code, Phinx needs , Arc42, Req42 and DocTooolchain..

BR Rainer