SQLiteCpp icon indicating copy to clipboard operation
SQLiteCpp copied to clipboard

Documentation improvement

Open cyber5tar86 opened this issue 2 years ago • 1 comments

I think it would be necessary to start thinking about structuring the documentation the same way as JSON for Modern C++ project documentation is managed

cyber5tar86 avatar Dec 27 '22 19:12 cyber5tar86

Hi I think that would be a good idea in order to improve adoption for SQLiteCpp, maybe this should be done on some smaller Issues/PRs like:

  • readme cleanup, and moving additional documentation to a docs directory
  • make a script in order to generate the proper documentation(and choose which system to use)
  • document properly the files which are not documented

after that

  • make a CI for the selected documentation generator
  • add sections for the library usage so we have something to show

and maybe as an additional step, add a translated version of the documentation(or just the readme)

UnixY2K avatar Jan 04 '23 00:01 UnixY2K