Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation improvement #402

Open
cyber5tar86 opened this issue Dec 27, 2022 · 1 comment
Open

Documentation improvement #402

cyber5tar86 opened this issue Dec 27, 2022 · 1 comment

Comments

@cyber5tar86
Copy link

cyber5tar86 commented Dec 27, 2022

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

@UnixY2K
Copy link
Contributor

UnixY2K commented Jan 4, 2023

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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants