diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 4a04dcb..f68a297 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -1,6 +1,20 @@ - +* [Pre-requisites](DEVELOPMENT.md#pre-requisites) +* [Getting Started](DEVELOPMENT.md#getting-started) +* [IDE Setup](DEVELOPMENT.md#ide-setup) +* [Technical Overview](DEVELOPMENT.md#technical-overview) + * [Recce Database](DEVELOPMENT.md#recce-database) + * [External data sources for Reconciliation](DEVELOPMENT.md#external-data-sources-for-reconciliation) + * [Build](DEVELOPMENT.md#build) + * [Testing](DEVELOPMENT.md#testing) + * [Testing conventions](DEVELOPMENT.md#testing-conventions) + * [Micronaut Tests](DEVELOPMENT.md#micronaut-tests) +* [Common problems](DEVELOPMENT.md#common-problems) + * [Running tests via Colima](DEVELOPMENT.md#running-tests-via-colima) + * [Out of Memory errors running within containers](DEVELOPMENT.md#out-of-memory-errors-running-within-containers) +* [For maintainers](DEVELOPMENT.md#for-maintainers) + * [Releasing](DEVELOPMENT.md#releasing) # Pre-requisites diff --git a/README.md b/README.md index 21c1f88..e834f2a 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,26 @@ You can read more about the ideas behind Recce at [DESIGN.md](docs/DESIGN.md) or ## Table of contents - +* [Recce Server](README.md#recce-server) + * [Features](README.md#features) + * [Table of contents](README.md#table-of-contents) +* [Getting Started](README.md#getting-started) +* [Configuration](README.md#configuration) + * [Configuring Recce itself](README.md#configuring-recce-itself) + * [Database configuration conveniences](README.md#database-configuration-conveniences) + * [Adding additional configuration files](README.md#adding-additional-configuration-files) + * [Configuring authentication](README.md#configuring-authentication) + * [Configuring datasources](README.md#configuring-datasources) + * [Driver/database specific configuration](README.md#driverdatabase-specific-configuration) + * [Customising datasource pooling](README.md#customising-datasource-pooling) + * [Configuring datasets](README.md#configuring-datasets) + * [Writing dataset queries](README.md#writing-dataset-queries) + * [The MigrationKey](README.md#the-migrationkey) + * [Ordering of columns](README.md#ordering-of-columns) + * [Handling differences](README.md#handling-differences) + * [Huge datasets and aggregates](README.md#huge-datasets-and-aggregates) +* [Development](README.md#development) +* [FAQ](README.md#faq) # Getting Started