docs: update overview of the project

* Add list of supported APIs
* Reorganize root pages in repo and on the website
* Fix broken links

Author: AndreyMarkinPPC

README.md

@@ -1,18 +1,26 @@
-# garf - Framework for interacting with reporting APIs
+# garf - Python library for interacting with reporting APIs
 
-`garf` is a framework for building various connectors to reporting API that provides
+`garf` is a Python library for building various connectors to reporting API that provides
 users with a SQL-like interface to specify what needs to be extracted from the API.
 
-It allows you to define SQL-like queries alongside aliases and custom extractors and specify where the results of such query should be stored.\
-Based on a query `garf` builds the correct request to a reporting API, parses response
-and transform it into a structure suitable for writing data.
+Write a query and  `garf` will do the rest- build the correct request to an API, parse response
+and writes it virtually anywhere.
 
 ## Key features
 
-* SQL-like syntax to interact with reporting APIs
-* Built-in support for writing data into various local / remote storage
-* Available as library, CLI, FastAPI endpoint
-* Easily extendable to support various APIs
+* Rich [SQL-like syntax](https://google.github.io/garf/usage/queries/) to interact with reporting APIs.
+* Built-in support for [writing data](https://google.github.io/garf/usage/writers/) into various local / remote storage.
+* Built-in support for post-processing saved data in [BigQuery](https://google.github.io/garf/usage/bq-executor/) & [SQL](https://google.github.io/garf/usage/sql-executor/) databases.
+* Easily [extendable](https://google.github.io/garf/development/overview/) to support various APIs.
+* Available as library, CLI, FastAPI endpoint.
+
+
+## Supported APIs
+
+* [YouTube Data API](https://google.github.io/garf/fetchers/youtube-data-api/)
+* [YouTube Reporting API](https://google.github.io/garf/fetchers/youtube-reporting-api/)
+* [Google Analytics](https://google.github.io/garf/fetchers/google-analytics-api/)
+* [Google Merchant Center](https://google.github.io/garf/fetchers/merchant-center-api/)
 
 
 ## Installation
@@ -21,36 +29,34 @@ and transform it into a structure suitable for writing data.
 pip install garf-executors
 ```
 
-
 ## Usage
 
+### Use `garf` CLI tool to fetch data from an API
+
+```bash
+echo 'SELECT id, name AS model, data.color AS color FROM objects' > query.sql
+garf  query.sql --source rest --source.endpoint=https://api.restful-api.dev
+```
+
 ### Get data from API to use in your code
 
 ```python
-from garf_core import ApiReportFetcher
-from garf_core.api_clients import FakeApiClient
+from garf_core.report_fetcher import ApiReportFetcher
+from garf_core.api_clients import RestApiClient
 from garf_io import writer
 
-my_api_client = FakeApiClient(results=[{'field': 1}])
-fetcher = ApiReportFetcher(my_api_client)
-report = fetcher.fetch('SELECT field FROM resource_name')
+api_client = RestApiClient(endpoint='https://api.restful-api.dev')
+fetcher = ApiReportFetcher(api_client)
+query = 'SELECT id, name AS model, data.color AS color FROM objects'
+report = fetcher.fetch(query)
 
 # Convert to Pandas
 report.to_pandas()
 
 # Write to CSV
-writer.create_writer('csv').write(report, 'api_data')
-
+writer.create_writer('console').write(report, 'api_data')
 ```
 
-### Use `garf` CLI tool to fetch data from an API
-
-
-```bash
-garf /path/to/queries \
-  --source youtube --source.channel=MY_CHANNEL_ID \
-  --output csv
-```
 
 ## Documentation
 

docs/development/create-garf-library.md

@@ -109,4 +109,4 @@ garf query.sql --source YOUR_API
 ```
 
 !!!note
-    Refer to [instructions](../libs/garf_executors/README.md#usage) for fetching data from your api via `garf` CLI tool.
+    Refer to [instructions](../usage/executors.md) for fetching data from your API via `garf` CLI tool.

docs/fetchers/youtube-reporting-api.md

@@ -4,23 +4,30 @@
 
 Install `garf-youtube-reporting-api` library
 
+/// tab | pip
 ```
 pip install garf-executors garf-youtube-reporting-api
 ```
+///
+
+/// tab | uv
+```
+uv add garf-executors garf-youtube-reporting-api
+```
+///
 
 ## Usage
 
 ```
 garf <PATH_TO_QUERIES> --source youtube-reporting-api \
-  --output <OUTPUT_TYPE> \
-  --source.<SOURCE_PARAMETER=VALUE>
+  --output csv \
+  --source.id=YOUTUBE_CHANNEL_ID
 ```
 
 where:
 
-* `<PATH_TO_QUERIES>` - local or remove files containing queries
-* `<OUTPUT_TYPE>` - output supported by [`garf-io` library](../garf_io/README.md).
-* `<SOURCE_PARAMETER=VALUE` - key-value pairs to refine fetching, check [available source parameters](#available-source-parameters).
+* `query` - local or remote path(s) to files with queries.
+* `output` - output supported by [`garf-io` library](https://google.github.io/garf/usage/writers/).
 
 ###  Available source parameters
 

docs/get-started/cli.md

@@ -18,9 +18,9 @@ garf <QUERIES> --source <API_SOURCE> \
 
 where
 
-* `<QUERIES>`- local or remote path(s) to files with queries.
-* `<API_SOURCE>`- type of API to use. Based on that the appropriate report fetcher will be initialized.
-* `<OUTPUT_TYPE>` - output supported by [`garf-io` library](../garf_io/README.md).
+* `query` - local or remote path(s) to files with queries.
+* `source`- type of API to use. Based on that the appropriate report fetcher will be initialized.
+* `output` - output supported by [`garf-io` library](https://google.github.io/garf/usage/writers/).
 
 If your report fetcher requires additional parameters you can pass them via key value pairs under `--source.` argument, i.e.`--source.regionCode='US'` - to get data only from *US*.
 > Concrete `--source` parameters are dependent on a particular report fetcher and should be looked up in a documentation for this fetcher.

docs/get-started/index.md

@@ -1,8 +1,6 @@
 # Overview
 
-Garf allows you to define SQL-like queries alongside aliases and custom extractors and specify where the results of such query should be stored.
-Based on such a query the library constructs the correct query to a reporting API of your choice, automatically extract all necessary fields from API schema
-and transform them into a structure suitable for writing data.
+`garf` can be used in a multiple ways.
 
 <div class="grid cards" markdown>
 

docs/index.md

@@ -1,23 +1,28 @@
-# garf
+# garf - Python library for interacting with reporting APIs
 
 ## What is garf?
 
-`garf` is a framework for building various connectors to reporting API that provides
+`garf` is a Python library for building various connectors to reporting API that provides
 users with a SQL-like interface to specify what needs to be extracted from the API.
 
-It allows you to define SQL-like queries alongside aliases and custom extractors
-and specify where the results of such query should be stored.
-Based on a query `garf` builds the correct request to a reporting API, parses response
-and transform it into a structure suitable for writing data.
+Write a query and  `garf` will do the rest- build the correct request to an API, parse response
+and writes it virtually anywhere.
 
 ## Key features
 
 
-* SQL-like syntax to interact with reporting APIs
-* Built-in support for writing data into various local / remote storage
-* Available as library, CLI, FastAPI endpoint
-* Easily extendable to support various APIs
+* Rich [SQL-like syntax](usage/queries.md) to interact with reporting APIs.
+* Built-in support for [writing data](usage/writers.md) into various local / remote storage.
+* Easily [extendable](development/overview.md) to support various APIs.
+* Built-in support for post-processing saved data in [BigQuery](usage/bq-executor.md) & [SQL](usage/sql-executor.md) databases.
+* Available as library, CLI, FastAPI endpoint.
 
+## Supported APIs
+
+* [YouTube Data API](fetchers/youtube-data-api.md)
+* [YouTube Reporting API](fetchers/youtube-reporting-api.md)
+* [Google Analytics](fetchers/google-analytics-api.md)
+* [Google Merchant Center](fetchers/merchant-center-api.md)
 
 ## Installation
 
@@ -36,8 +41,28 @@ uv add garf-executors
 
 ## Usage
 
+### CLI
+
 ```bash
-garf /path/to/queries \
-  --source youtube --source.channel=MY_CHANNEL_ID \
-  --output csv
+echo 'SELECT id, name AS model, data.color AS color FROM objects' > query.sql
+garf  query.sql --source rest --source.endpoint=https://api.restful-api.dev
+```
+
+### Python library
+
+```python
+from garf_core.report_fetcher import ApiReportFetcher
+from garf_core.api_clients import RestApiClient
+from garf_io import writer
+
+api_client = RestApiClient(endpoint='https://api.restful-api.dev')
+fetcher = ApiReportFetcher(api_client)
+query = 'SELECT id, name AS model, data.color AS color FROM objects'
+report = fetcher.fetch(query)
+
+# Convert to Pandas
+report.to_pandas()
+
+# Write to CSV
+writer.create_writer('console').write(report, 'api_data')
 ```

docs/usage/bq-executor.md

@@ -23,7 +23,7 @@ garf <QUERIES> --source bq \
 where
 
 * `query`- local or remote path(s) to files with queries.
-* `output` - output supported by [`garf-io` library](../garf_io/README.md).
+* `output` - output supported by [`garf-io` library](https://google.github.io/garf/usage/writers/).
 ///
 
 /// tab | Python