Documentation Automation tool

Development / Github
1

There was a need in the community to create a tool which can read through metadata in the source code and create reliable output which contains data about the tool and it’s icon data along with the aliases, Though i did build basic tool before today i tried to revitalise it by making it output CSV files.

Source Code of the Tool:

Discussion:

2 Likes
2

This tool directly addresses one of our biggest ongoing challenges: keeping the reference documentation in sync with the codebase. It aims to replace:

To move from prototype to production-ready documentation generator, I suggest the following implementation path:

  1. Run the parser across all top-level Menus except Drawing Tools, then separately across all Drawing Tools.
  2. Validate outputs and tweak the code, recognising that automated documentation will not perfectly match manually written content.
  3. Hand over to the docs team to integrate into the documentation build and automation workflow.

That would complete the tool side; the docs team can then decide how best to integrate it into the build and release workflow.

3

I suppose we’ll end up with something like AI based documentation generation as soon as dev branch will be more or less stabilized for the next version. So far changes are quite significant, and maintaining both documentation and do active development is quite a challenging task (at least for me). I try to put all changes into descriptions of PR created by me ( Pull requests · LibreCAD/LibreCAD · GitHub ) but it is obvious that something may be missed there.
And you’re right - documentation is one of the biggest challenge.