[FEAT] automatic class documentation header #144
Description
To enhance the documentation of the core, I would love to see an action that runs on every pull request and adds a small three-line documentation snippet to every class that was touched in that specific pull request. The contributor and the reviewer are then supposed to go the extra mile, and also review these three lines of documentation.
The content of these three lines should be a description about the purpose of the class.
This would greatly improve the documentation of the core code overtime, and it's just a little overhead for every contributor.
Technically speaking, this action Would connect to a GPT API, send the class content as part of the prompt and receive the formatted three lines of documentation. The action can further validate The format and syntax.
This approach follows the Boy Scout principal, and is very defensive in terms of actual changes. We could also just write the comments with chat GPT as we did in a similar fashion for the developer documentation.