Skip to content

Conversation

@Skwangles
Copy link
Contributor

@Skwangles Skwangles commented Jul 31, 2025

At my work, we've found an enourmous benefit to using AI to generate some overview documentation, especially around the Architectural side.

Idea being this is more of a developer docs, than the read-the-docs page, especially given the mermaid docs.
I can alo integrate gh coplit to auto update them here on PR.

It makes things a lot easier to start contributing if you can get a basic mental model of how the code is structured and works, even if it is not comprehensive.

This branch:
Uses GenAI to provide architectural diagrams, summarise the key components and classes. Provides a more thorough break down than the existing readthedocs on configuration parameters.

Uses GenAI to provide architectural diagrams, summarise the key components and classes.
Provides a more thorough break down than the existing readthedocs on configuration parameters.
@Skwangles
Copy link
Contributor Author

Future thing I can add in is a GitHub action with GH copilot to auto update these docs when new PRs are merged? Some attempt to avoid stale docs

@Skwangles Skwangles closed this Jul 31, 2025
@Skwangles
Copy link
Contributor Author

I'll actually integrate them into the read-the-docs

@Skwangles Skwangles deleted the docs/developer-overview-docs branch August 3, 2025 10:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant