Fabric docs site

[productStripesAdmin]

Hello! I would like to gauge whether there's any interest in creating a documentation site for Fabric. Using a tool like MkDocs or Docusauris.

I have found the current READMEs and docs to be v useful, however, it can be difficult to find things and there does appear to be some gaps. A dedicated docs site would help to organize content and also streamline onboarding, learning, and contributing.

If there is sufficient interest, I'm open to creating a show-and-tell project with a proposed structure and going from there.

[productStripesAdmin]

Fabric was wonderful, but it’s now contained within PAI. And any time I want to document something for a blog post or video or whatever, I’ll do research and put it in Substrate. SO EXCITED about this.

• Source: Unsupervised Learning NO. 503

🙄

Overall, I like what @danielmiessler is doing here but there does seem to be a lack of coordination and communication when it comes to the public facing repos. A clearly articulated plan that includes the status of each project/repo and how people can contribute would help imho.

[aborruso]

I agree that it would be very useful, but I must say that using deepwiki is already very useful: https://deepwiki.com/danielmiessler/Fabric

[ksylvan]

@productStripesAdmin @aborruso I'm in contact with @danielmiessler all the time and I'm continuing to maintain Fabric and will continue to do so.

We are constantly adding new LLM providers and features, as you can see by the cadence of releases (and pull requests getting merged).

That said, I'll also be tackling getting myself ramped up on PAI as soon as I have my job search or consulting situation under control.

[aborruso]

I wasn't criticizing you. If I knew how to write Go code, I'd help out.

It was just a note, to be used when possible in the future.

If it's not possible, thank you very much anyway.

[ksylvan]

😁 I didn't think you were criticizing me at all, @aborruso. I was just responding to the remark about " lack of coordination and communication when it comes to the public-facing repos." 😉

• I ensure that the README "Updates" section highlights every new feature, if it's significant enough.
• Each new release has its release and CHANGELOG entry, and...
• I occasionally create a discussion post about the new release features.

What else is missing in terms of coordination and communication?

@danielmiessler and I chat regularly about the project. The roadmap he's articulated to me is that he wants to focus on Substrate and PAI and have Fabric be part of the background infrastructure. It's an extremely important part and I'll continue to maintain it.

For contributors, I have a clearly laid out CONTRIBUTING tab—and I'm not strict about people who want to create a PR and who forget to use the generate_changelog tool to create their CHANGELOG entry.

[ksylvan]

Hello! I would like to gauge whether there's any interest in creating a documentation site for Fabric. Using a tool like MkDocs or Docusauris.

I have found the current READMEs and docs to be v useful, however, it can be difficult to find things and there does appear to be some gaps. A dedicated docs site would help to organize content and also streamline onboarding, learning, and contributing.

If there is sufficient interest, I'm open to creating a show-and-tell project with a proposed structure and going from there.

@productStripesAdmin If there are gaps, please create an issue for me with the specifics. I make some effort to make sure the documentation is current and up to date and I regularly create new extended documentation for features.

[ksylvan]

I just added an introductory sentence in the REAME about the docs/ folder and a link to DeepWIki

https://github.com/danielmiessler/Fabric?tab=readme-ov-file#updates

Let me know what you both think, please. @productStripesAdmin @aborruso

[ksylvan]

Here is Daniel's overall context for how his projects fit together and how they are all related:

https://www.youtube.com/watch?v=5x4s2d3YWak&t=1s