Documentation improvements

alan-turing-institute / sqlsynthgen

Synthetic data for SQL databases

MIT License

11 stars 1 forks source link

Closed mhauru closed 1 year ago

mhauru commented 1 year ago

This PR

Adds a folder called examples and in it the CC HIC config in full.
Reworks the OMOP tutorial page in our documentation completely, structuring it around the CC HIC config.
Restructures and renames many of the documentation pages, and adds guidance to new users on the index page on where to start.

mhauru commented 1 year ago

I'm very confused by the behavior of the pre-commit action. It passes locally. It passed in the second to last commit: https://github.com/alan-turing-institute/sqlsynthgen/actions/runs/6510468903/job/17684233167 But then I made change to .readthedocs.yaml and nothing else, and now its failing: https://github.com/alan-turing-institute/sqlsynthgen/actions/runs/6510709245/job/17684974615 Are we dealing with some nasty non-deterministic behavior?

mhauru commented 1 year ago

The pre-commit passed by pure luck, I haven't fixed the problem, or even understood what the problem is.