Open iansan5653 opened 2 years ago
There are certainly fewer issues with converting the markdown to html. Startup may be a bad time to do that as modifying an application bundle on the fly is likely to raise security flags in the future. I find it better to generate files immediately after updates.
I also do not think it is a bad idea to include the file in the VCS. Building documentation is usually one of the last steps before a release and the documentation should be under VCS.
My 2p.
When I wrote the manual, I intentionally didn't include the PDF version in the source code so that we would have a single copy of the file in the repository. This is a bit confusing though since when you run the code locally, the "Help" button is broken.
Instead, I think a better strategy would be to build an HTML file on startup and link to that instead.