Doc tweaks

[ZmeiGorynych]

Summary by CodeRabbit

• Documentation
  • Redesigned landing page with hero image, example JSON queries, and reorganized navigation
  • Added aggregations tutorial covering query-time aggregation and custom aggregations
  • Expanded feature descriptions and documentation examples across all pages
  • Updated documentation navigation: Examples section renamed to Tutorials

[coderabbitai]

📝 Walkthrough

Walkthrough

Documentation updates across README, landing page, examples, and site navigation to document query-time aggregation features where aggregations are selected per query using colon syntax, support for custom SQL-templated aggregations, and a new aggregations tutorial section.

Changes

Cohort / File(s)	Summary
Core Documentation README.md, docs/index.md	Updated to emphasize query-time aggregation where measures are row-level expressions and aggregations are selected per query using colon syntax (e.g., "revenue:sum"). Added documentation for custom aggregations with SQL templates and allowed_aggregations whitelists. Restructured landing page with hero image, capability sections, and JSON example.
Examples and Navigation docs/examples/01_dynamic/dynamic.md, mkdocs.yml	Added paragraph defining query-time aggregation with colon syntax examples. Renamed Examples to Tutorials in mkdocs.yml and added new Aggregations tutorial entry pointing to examples/07_aggregations/aggregations.md and corresponding notebook.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

• PR #2: Modifies README to emphasize query-time metrics/aggregations alongside similar documentation patterns.
• PR #20: Directly overlaps with README "What's new" section updates for query-time and custom aggregations features.
• PR #18: Both PRs modify mkdocs.yml navigation structure and add/update example documentation content.

Poem

🐰 Hops through the docs with glee,
Query-time aggregations, now you'll see!
Colon syntax dances in every line,
Custom measures, oh how they shine!
Tutorials bloom, the features take flight,
Documentation's renewed—what a delight! 🎉

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title "Doc tweaks" is vague and generic, using non-descriptive language that doesn't convey what documentation changes were made.	Consider a more specific title that highlights the main documentation change, such as "Document query-time aggregation feature" or "Restructure docs landing page and add aggregations tutorial".

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch egor/doc-tweaks

Warning

Review ran into problems

🔥 Problems

Timed out fetching pipeline failures after 30000ms

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/index.md`:
- Line 62: The fenced code block in the docs architecture diagram is missing a
language tag causing MD040 lint failures; update the fence that currently starts
with ``` to include a language identifier (e.g., ```text) so the block
containing the flow lines for Agent, MCP / REST API / Python SDK, SlayerQuery,
SlayerQueryEngine, EnrichedQuery, SQLGenerator, SlayerSQLClient, and
SlayerResponse is annotated as plain text.

In `@README.md`:
- Line 27: Update the README wording for consistency: replace "parametrized"
with "parameterized" in the Aggregation-at-query-time paragraph and convert the
trailing fragment into a full sentence—e.g., end the paragraph with "Supports
per-measure `allowed_aggregations` whitelists."—so the phrasing is clearer and
consistent across the docs.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e11aa5f5-b179-4727-845e-d8a358a0ab3d

📥 Commits

Reviewing files that changed from the base of the PR and between ba00128 and 199ec1b.

📒 Files selected for processing (4)

• README.md
• docs/examples/01_dynamic/dynamic.md
• docs/index.md
• mkdocs.yml

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Add a language tag to the fenced block.

The architecture block fence is missing a language identifier (MD040), which can fail markdown linting.

Suggested fix

-```
+```text
 Agent --> MCP / REST API / Python SDK
               |
 
          SlayerQuery (model, fields, dimensions, filters)
               |
 
          SlayerQueryEngine (resolves model definitions from storage)
               |
 
          EnrichedQuery (resolved SQL expressions, model metadata)
               |
 
          SQLGenerator (sqlglot AST --> dialect-aware SQL)
               |
 
          SlayerSQLClient (SQLAlchemy --> database)
               |
          SlayerResponse (data, columns, sql)

</details>

<!-- suggestion_start -->

<details>
<summary>📝 Committable suggestion</summary>

> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

```suggestion

🧰 Tools

🪛 markdownlint-cli2 (0.22.0)

[warning] 62-62: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@docs/index.md` at line 62, The fenced code block in the docs architecture
diagram is missing a language tag causing MD040 lint failures; update the fence
that currently starts with ``` to include a language identifier (e.g., ```text)
so the block containing the flow lines for Agent, MCP / REST API / Python SDK,
SlayerQuery, SlayerQueryEngine, EnrichedQuery, SQLGenerator, SlayerSQLClient,
and SlayerResponse is annotated as plain text.