Developer Documentation - Overview of architecture, key classes, configuration options, and components #649
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.