1909 update documentation

Author: Cmdv

Readme.md

@@ -20,7 +20,9 @@ instance fully synced to a specific network is:
 * Look up the balance of any stake address for any Shelley or later epoch.
 * Look up the amount of ADA delegated to each pool for any Shelley or later epoch.
 
-Example SQL queries are available at [Example Queries][ExampleQueries]. You can also find some [DB Sync best practices here](https://docs.cardano.org/cardano-components/cardano-db-sync/best-practices).
+## Documentation
+
+The [doc/](https://github.com/IntersectMBO/cardano-db-sync/blob/master/doc/Readme.md) directory,  offers essential resources for users, including guides for installation with and without Nix, configuration. Key files cover, Docker usage, PostgreSQL example queries, command-line options and database migrations. There's also a troubleshooting guide for common issues. These documents provide users with the necessary steps to effectively set up and maintain the Cardano DB Sync.
 
 ## Architecture
 

doc/Readme.md

@@ -0,0 +1,69 @@
+# Documentation Table of Contents
+
+## Overview
+
+This directory contains various documentation files for setting up, configuring, and running the Cardano DB Sync Node. Below is a list of available documents, ordered by their importance for users.
+
+
+1. [Installing](https://github.com/IntersectMBO/cardano-db-sync/blob/master/doc/installing.md)
+   - Steps for installing the Cardano DB Sync from source without using Nix.
+
+2. [Installing with Nix](https://github.com/IntersectMBO/cardano-db-sync/blob/master/doc/installing-with-nix.md)
+    - Steps for installing Cardano DB Sync using Nix.
+
+3. [Building and Running](https://github.com/IntersectMBO/cardano-db-sync/blob/master/doc/building-running.md)
+   - Instructions for setting up and running the Cardano DB Sync Node.
+
+4. [Configuration](https://github.com/IntersectMBO/cardano-db-sync/blob/master/doc/configuration.md)
+   - Details on how to configure the Cardano DB Sync Node.
+
+5. [Command Line Options](https://github.com/IntersectMBO/cardano-db-sync/blob/master/doc/command-line-options.md)
+    - Documentation on command-line options for the Cardano DB Sync Node.
+
+6. [Running](https://github.com/IntersectMBO/cardano-db-sync/blob/master/doc/running.md)
+   - Guide to running the Cardano DB Sync Node.
+
+7. [Docker](https://github.com/IntersectMBO/cardano-db-sync/blob/master/doc/docker.md)
+   - Instructions for using Docker to run the Cardano DB Sync Node.
+
+8. [Upgrading PostgreSQL](https://github.com/IntersectMBO/cardano-db-sync/blob/master/doc/upgrading-postgresql.md)
+   - Guide for upgrading PostgreSQL versions for use with Cardano DB Sync.
+
+9. [Validation](https://github.com/IntersectMBO/cardano-db-sync/blob/master/doc/validation.md)
+   - Information on the validation process for genesis, blocks, transactions, and runtime rewards.
+
+10. [Migrations](https://github.com/IntersectMBO/cardano-db-sync/blob/master/doc/migrations.md)
+   - Details on database migrations for different versions of Cardano DB Sync.
+
+11. [Schema](https://github.com/IntersectMBO/cardano-db-sync/blob/master/doc/schema.md)
+   - Overview of the database schema used by the Cardano DB Sync Node.
+
+12. [Schema Management](https://github.com/IntersectMBO/cardano-db-sync/blob/master/doc/schema-management.md)
+    - Instructions on managing database schema and creating migrations.
+
+13. [Syncing and Rollbacks](https://github.com/IntersectMBO/cardano-db-sync/blob/master/doc/syncing-and-rollbacks.md)
+    - Details on the syncing procedure and handling rollbacks.
+
+14. [Community Tools](https://github.com/IntersectMBO/cardano-db-sync/blob/master/doc/community-tools.md)
+    - Information on various community tools like Koios and Blockfrost.
+
+15. [Interesting Queries](https://github.com/IntersectMBO/cardano-db-sync/blob/master/doc/interesting-queries.md)
+    - A collection of useful SQL queries for interacting with the database.
+    
+16. [Troubleshooting](https://github.com/IntersectMBO/cardano-db-sync/blob/master/doc/troubleshooting.md)
+    - Common issues and troubleshooting steps for Cardano DB Sync.
+
+17. [Release Process](https://github.com/IntersectMBO/cardano-db-sync/blob/master/doc/release-process.md)
+    - Detailed process for releasing new versions of Cardano DB Sync.
+
+18. [State Snapshot](https://github.com/IntersectMBO/cardano-db-sync/blob/master/doc/state-snapshot.md)
+    - Guide to creating and restoring state snapshots.
+
+19. [Pool OffChain Data](https://github.com/IntersectMBO/cardano-db-sync/blob/master/doc/pool-offchain-data.md)
+    - Handling off-chain data for staking pools.
+
+20. [SMASH](https://github.com/IntersectMBO/cardano-db-sync/blob/master/doc/smash.md)
+    - Information on the Stakepool Metadata Aggregation Server (SMASH).
+
+21. [HLint and Stylish Haskell](https://github.com/IntersectMBO/cardano-db-sync/blob/master/doc/hlint-stylish-haskell.md)
+    - Setting up `hlint` and `stylish-haskell` for code linting and formatting.