Skip to content

docs: add docs for config file#88

Merged
ssnd merged 3 commits intomainfrom
0-config-docs-v2
Sep 10, 2025
Merged

docs: add docs for config file#88
ssnd merged 3 commits intomainfrom
0-config-docs-v2

Conversation

@ssnd
Copy link
Contributor

@ssnd ssnd commented Aug 19, 2025

Summary by CodeRabbit

  • Documentation
    • Added centralized Configuration reference in English and Russian, covering addresses, storage, cluster, limits, compression, indexing, API, tracing, and more, with defaults and unit conventions.
    • Removed legacy CLI Flags guides (EN/RU) in favor of configuration-based setup.
    • Updated guidance: enable rate limiting via limits.query_rate; enable case sensitivity via indexing.case_sensitive.
    • Renamed troubleshooting parameter from frac-size to storage.frac_size and updated related references.
    • Refreshed internal notes to align with new configuration options.

@codecov-commenter
Copy link

codecov-commenter commented Aug 19, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.50%. Comparing base (08f1a3d) to head (4918d19).

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #88      +/-   ##
==========================================
- Coverage   71.52%   71.50%   -0.02%     
==========================================
  Files         201      201              
  Lines       18167    18167              
==========================================
- Hits        12994    12991       -3     
- Misses       4454     4456       +2     
- Partials      719      720       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@coderabbitai
Copy link

coderabbitai bot commented Aug 19, 2025

📝 Walkthrough

Walkthrough

Adds centralized configuration references in English and Russian, removes legacy CLI flags docs, and updates existing docs to point to new configuration options (case sensitivity, rate limiting, frac size) and new anchors. All changes are documentation-only; no code or API modifications.

Changes

Cohort / File(s) Summary
Add configuration references
docs/en/02-configuration.md, docs/ru/02-configuration.md
New comprehensive configuration reference docs with structured sections, defaults, units, and precedence notes.
Remove legacy flags docs
docs/en/02-flags.md, docs/ru/02-flags.md
Deleted CLI flags reference pages for both languages.
Update rate limiting to config option
docs/en/08-rate-limiting.md, docs/ru/08-rate-limiting.md
Replace flag-based guidance with limits.query_rate; remove explicit default mention.
Update case sensitivity config
docs/en/05-seq-ql.md
Switch guidance from --case-sensitive flag to indexing.case_sensitive.
Rename frac size to storage.frac_size and update links
docs/en/09-troubleshooting.md, docs/ru/09-troubleshooting.md
Rename parameter, adjust wording, and update links to configuration reference.
Internal frac-cache docs update
docs/en/internal/frac-cache.md, docs/ru/internal/frac-cache.md
Reference storage.frac_size instead of frac-size flag; wording otherwise unchanged.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • docs: add async search docs #91 — Also documents async search configuration (including data_dir derivation and limits), overlapping with the new configuration reference.

Suggested labels

documentation

Suggested reviewers

  • moflotas
  • ssnd
  • eguguchkin

Pre-merge checks (3 passed)

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title accurately reflects the primary change by indicating that documentation for the configuration file is being added, even if it repeats “docs” and could be more precise.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch 0-config-docs-v2

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@moflotas moflotas self-requested a review September 3, 2025 11:01
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (5)
docs/en/12-configuration.md (3)

16-16: Fix typos, capitalization, and minor grammar for clarity and consistency.

Small copyedits to improve polish.

- | `address.grpc` | string | `:9004` | GRPC listen address |
+ | `address.grpc` | string | `:9004` | gRPC listen address |

-| `cluster.read_stores` | []string | - | Cold store instances wich will be queried from |
+| `cluster.read_stores` | []string | - | Cold store instances which will be queried from |

-| `cluster.hot_replicas` | int | - | Number if hot instances that belong to one shard. If specified will take precedence over `cluster.replicas` for hot stores |
+| `cluster.hot_replicas` | int | - | Number of hot instances that belong to one shard. If specified, takes precedence over `cluster.replicas` for hot stores |

-| `cluster.mirror_address` | string | - | Host to which search queries will be mirrored. It can be useful if you have development cluster and you want to have same search pattern as you have on production cluster |
+| `cluster.mirror_address` | string | - | Host to mirror search queries to (useful to mimic production search patterns on a development cluster) |

-| `circuit_breaker.bulk.shard_timeout` | Duration | `10s` | Checkout [CircuitBreaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) for more information |
+| `circuit_breaker.bulk.shard_timeout` | Duration | `10s` | See [Circuit Breaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) for details |
-| `circuit_breaker.bulk.err_percentage` | int | `50` | Checkout [CircuitBreaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) for more information |
+| `circuit_breaker.bulk.err_percentage` | int | `50` | See [Circuit Breaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) for details |
-| `circuit_breaker.bulk.bucket_width` | Duration | `1s` | Checkout [CircuitBreaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) for more information |
+| `circuit_breaker.bulk.bucket_width` | Duration | `1s` | See [Circuit Breaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) for details |
-| `circuit_breaker.bulk.buckets_count` | int | `10` | Checkout [CircuitBreaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) for more information |
+| `circuit_breaker.bulk.buckets_count` | int | `10` | See [Circuit Breaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) for details |
-| `circuit_breaker.bulk.sleep_window` | Duration | `5s` | Checkout [CircuitBreaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) for more information |
+| `circuit_breaker.bulk.sleep_window` | Duration | `5s` | See [Circuit Breaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) for details |
-| `circuit_breaker.bulk.volume_threshold` | int | `5` | Checkout [CircuitBreaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) for more information |
+| `circuit_breaker.bulk.volume_threshold` | int | `5` | See [Circuit Breaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) for details |

-| `resources.reader_workers` | int | runtime.GOMAXPROCS | Number of workers for readers pool. By default this setting is equal to runtime.GOMAXPROCS |
+| `resources.reader_workers` | int | `runtime.GOMAXPROCS` | Number of workers for the readers pool. By default, equals `runtime.GOMAXPROCS` |
-| `resources.search_workers` | int | runtime.GOMAXPROCS | Number of workers for searchers pool. By default this setting is equal to runtime.GOMAXPROCS |
+| `resources.search_workers` | int | `runtime.GOMAXPROCS` | Number of workers for the searchers pool. By default, equals `runtime.GOMAXPROCS` |
-| `resources.cache_size` | Bytes | 30% of available RAM | Maxium size of cache. By default this setting is equal to 30% of available RAM |
+| `resources.cache_size` | Bytes | 30% of available RAM | Maximum cache size. By default, equals 30% of available RAM |

-| `docs_sorting.enabled` | bool | `false` | Enables/disables documents sorting |
+| `docs_sorting.enabled` | bool | `false` | Enables/disables document sorting |

-| `async_search.data_dir` | string | subdirectory in storage.data_dir | Directory that contains data for asynchronous searches. By default will be subdirectory in `storage.data_dir` |
+| `async_search.data_dir` | string | subdirectory of `storage.data_dir` | Directory that contains data for asynchronous searches. By default, a subdirectory of `storage.data_dir` |

Also applies to: 36-36, 40-40, 42-42, 84-89, 97-99, 142-142, 151-151


62-69: Clarify “per-second” vs “concurrent” wording in Limits.

“Simultaneous requests per second” is contradictory. Suggest explicit QPS vs concurrency terms.

-| `limits.query_rate` | float64 | `2` | Maximum amount of requests per second |
+| `limits.query_rate` | float64 | `2` | Maximum requests per second (QPS) |
-| `limits.search_requests` | int | `32` | Maximum amount of simultaneous requests per second |
+| `limits.search_requests` | int | `32` | Maximum number of concurrent search requests |
-| `limits.bulk_requests` | int | `32` | Maximum amount of simultaneous requests per second |
+| `limits.bulk_requests` | int | `32` | Maximum number of concurrent bulk requests |
-| `limits.inflight_bulks` | int | `32` | Maximum amount of simultaneous requests per second |
+| `limits.inflight_bulks` | int | `32` | Maximum number of in-flight bulk operations |
-| `limits.fraction_hits` | int | `6000` | Maximum amount of fractions that can be processed within single search request |
+| `limits.fraction_hits` | int | `6000` | Maximum number of fractions that can be processed within a single search request |
-| `limits.search_docs` | int | `100000` | Maximum amount of documents that can be returned within single search request |
+| `limits.search_docs` | int | `100000` | Maximum number of documents that can be returned within a single search request |
-| `limits.doc_size` | Bytes | `128KiB` | Maximum possible size for single document. Document larger than this threshold will be skipped |
+| `limits.doc_size` | Bytes | `128KiB` | Maximum size of a single document; larger documents are skipped |

172-175: Required vs optional: audit fields with “-” defaults.

The note says “no default => required,” but several fields appear optional (e.g., cluster.hot_read_stores, cluster.hot_replicas, resources.sort_docs_cache_size, async_search.concurrency). Consider marking optional fields explicitly in the Description, or add an “Required” column.

docs/ru/12-configuration.md (2)

16-16: Исправления опечаток и формулировок (стиль и единообразие).

Мелкие правки для читаемости и консистентности.

-| `address.grpc` | string | `:9004` | Адрес прослушивания GRPC |
+| `address.grpc` | string | `:9004` | Адрес прослушивания gRPC |

-| `storage.total_size` | Bytes | `1GiB` | Верхняя граница дискового пространства, которое может быть занято запечатанными фракциями перед их удалением (или отгрузкой в remote хранилище) |
+| `storage.total_size` | Bytes | `1GiB` | Верхняя граница дискового пространства, занимаемого запечатанными фракциями, перед их удалением (или выгрузкой в удалённое хранилище) |

-| `limits.search_requests` | int | `32` | Максимальное количество одновременных запросов в секунду |
+| `limits.search_requests` | int | `32` | Максимальное число одновременных поисковых запросов |
-| `limits.bulk_requests` | int | `32` | Максимальное количество одновременных запросов в секунду |
+| `limits.bulk_requests` | int | `32` | Максимальное число одновременных bulk‑запросов |
-| `limits.inflight_bulks` | int | `32` | Максимальное количество одновременных запросов в секунду |
+| `limits.inflight_bulks` | int | `32` | Максимальное число одновременно выполняющихся bulk‑операций |

-| `limits.aggregation.fraction_tokens` | int | `100000` | Максимальное количество уникальных токенов, содержащихся в одной фракции, которая была выбран запросом агрегации. Установка этого поля в 0 отключает лимит |
+| `limits.aggregation.fraction_tokens` | int | `100000` | Максимальное количество уникальных токенов, содержащихся в одной фракции, которая была выбрана запросом агрегации. Установка этого поля в 0 отключает лимит |

-| Настройки CircuitBreaker для bulk-операций. См. [документацию CircuitBreaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) для дополнительной информации.
+| Настройки Circuit Breaker для bulk‑операций. См. [документацию Circuit Breaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) для деталей.

-| `circuit_breaker.bulk.shard_timeout` | Duration | `10s` | См. [CircuitBreaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) для дополнительной информации |
+| `circuit_breaker.bulk.shard_timeout` | Duration | `10s` | См. [Circuit Breaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) |
-| `circuit_breaker.bulk.err_percentage` | int | `50` | См. [CircuitBreaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) для дополнительной информации |
+| `circuit_breaker.bulk.err_percentage` | int | `50` | См. [Circuit Breaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) |
-| `circuit_breaker.bulk.bucket_width` | Duration | `1s` | См. [CircuitBreaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) для дополнительной информации |
+| `circuit_breaker.bulk.bucket_width` | Duration | `1s` | См. [Circuit Breaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) |
-| `circuit_breaker.bulk.buckets_count` | int | `10` | См. [CircuitBreaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) для дополнительной информации |
+| `circuit_breaker.bulk.buckets_count` | int | `10` | См. [Circuit Breaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) |
-| `circuit_breaker.bulk.sleep_window` | Duration | `5s` | См. [CircuitBreaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) для дополнительной информации |
+| `circuit_breaker.bulk.sleep_window` | Duration | `5s` | См. [Circuit Breaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) |
-| `circuit_breaker.bulk.volume_threshold` | int | `5` | См. [CircuitBreaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) для дополнительной информации |
+| `circuit_breaker.bulk.volume_threshold` | int | `5` | См. [Circuit Breaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) |

-| `resources.reader_workers` | int | runtime.GOMAXPROCS | Количество воркеров для пула чтения. По умолчанию эта настройка равна runtime.GOMAXPROCS |
+| `resources.reader_workers` | int | `runtime.GOMAXPROCS` | Количество воркеров пула чтения. По умолчанию равно `runtime.GOMAXPROCS` |
-| `resources.search_workers` | int | runtime.GOMAXPROCS | Количество воркеров для пула поиска. По умолчанию эта настройка равна runtime.GOMAXPROCS |
+| `resources.search_workers` | int | `runtime.GOMAXPROCS` | Количество воркеров пула поиска. По умолчанию равно `runtime.GOMAXPROCS` |

-| `async_search.data_dir` | string | поддиректория в storage.data_dir | Директория, содержащая данные для асинхронных поисков. По умолчанию будет поддиректорией в `storage.data_dir` |
+| `async_search.data_dir` | string | поддиректория в `storage.data_dir` | Директория, содержащая данные для асинхронных поисков. По умолчанию — поддиректория в `storage.data_dir` |

Also applies to: 28-28, 63-65, 76-76, 80-80, 84-89, 97-99, 151-151


172-175: Обязательные vs опциональные поля: синхронизировать с примечанием.

Примечание говорит «без значения по умолчанию ⇒ обязательно», но часть полей фактически опциональны (например, cluster.hot_read_stores, cluster.hot_replicas, resources.sort_docs_cache_size, async_search.concurrency). Лучше явно отмечать «(опционально)» в описаниях или добавить отдельную колонку.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a1939d1 and a139084.

📒 Files selected for processing (2)
  • docs/en/12-configuration.md (1 hunks)
  • docs/ru/12-configuration.md (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: test
🔇 Additional comments (2)
docs/en/12-configuration.md (1)

1-3: Ensure your docs tool supports identical front-matter IDs across locales. I couldn’t detect which engine you’re using—confirm that id: configuration on both EN and RU pages won’t collide at build time.

docs/ru/12-configuration.md (1)

1-3: Уточните движок документации и проверьте уникальность id front-matter
Не удалось найти конфигурационные файлы генератора; убедитесь, что одинаковый id configuration в разных локалях (RU/EN) не создаёт конфликтов маршрутизации.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (11)
docs/en/05-seq-ql.md (1)

16-16: Clarify scope + link to config anchor.

Explicitly state that existing data requires reindexing and link to the config reference for indexing.case_sensitive.

- To change this behavior, use the `indexing.case_sensitive` option, but it affects only new documents.
+ To change this behavior, set `indexing.case_sensitive` in the configuration; it applies only to newly indexed documents (existing data requires reindexing). See [Indexing configuration](02-configuration.md#indexing-configuration).
docs/en/08-rate-limiting.md (1)

33-35: Cross-link to config and add a minimal example.

A link to the central config and a short YAML snippet will help users.

-The rate limiter can be enabled on launch using the `limits.query_rate` option 
-followed by a number -- the maximum number of queries allowed per second. 
+Enable rate limiting via the `limits.query_rate` option (maximum queries per second). See [Limits configuration](02-configuration.md#limits-configuration).
+
+Example:
+```yaml
+limits:
+  query_rate: 2
+```
docs/ru/02-configuration.md (2)

16-16: Stylistic: use “gRPC”.

-| `address.grpc` | string | `:9004` | Адрес прослушивания GRPC |
+| `address.grpc` | string | `:9004` | Адрес прослушивания gRPC |

63-66: Wording: “одновременных … в секунду” is contradictory.

These are concurrency limits, not “per second”.

-| `limits.search_requests` | int | `32` | Максимальное количество одновременных запросов в секунду |
-| `limits.bulk_requests` | int | `32` | Максимальное количество одновременных запросов в секунду |
-| `limits.inflight_bulks` | int | `32` | Максимальное количество одновременных запросов в секунду |
+| `limits.search_requests` | int | `32` | Максимальное количество одновременных запросов |
+| `limits.bulk_requests` | int | `32` | Максимальное количество одновременных запросов |
+| `limits.inflight_bulks` | int | `32` | Максимальное количество одновременных bulk-запросов |
docs/en/02-configuration.md (5)

36-43: Fix typos and improve phrasing.

-| `cluster.read_stores` | []string | - | Cold store instances wich will be queried from |
+| `cluster.read_stores` | []string | - | Cold store instances which will be queried from |
-| `cluster.hot_replicas` | int | - | Number if hot instances that belong to one shard. If specified will take precedence over `cluster.replicas` for hot stores |
+| `cluster.hot_replicas` | int | - | Number of hot instances that belong to one shard. If specified, takes precedence over `cluster.replicas` for hot stores |
-| `cluster.mirror_address` | string | - | Host to which search queries will be mirrored. It can be useful if you have development cluster and you want to have same search pattern as you have on production cluster |
+| `cluster.mirror_address` | string | - | Host to which search queries will be mirrored. Useful if you have a development cluster and want to have the same search pattern as production |

62-66: Concurrency wording (not “per second”).

-| `limits.search_requests` | int | `32` | Maximum amount of simultaneous requests per second |
-| `limits.bulk_requests` | int | `32` | Maximum amount of simultaneous requests per second |
-| `limits.inflight_bulks` | int | `32` | Maximum amount of simultaneous requests per second |
+| `limits.search_requests` | int | `32` | Maximum number of concurrent requests |
+| `limits.bulk_requests` | int | `32` | Maximum number of concurrent requests |
+| `limits.inflight_bulks` | int | `32` | Maximum number of concurrent bulk requests |

84-89: “Checkout” → “See” for consistency.

-| `circuit_breaker.bulk.shard_timeout` | Duration | `10s` | Checkout [CircuitBreaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) for more information |
+| `circuit_breaker.bulk.shard_timeout` | Duration | `10s` | See the [CircuitBreaker documentation](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) for more information |
-| `circuit_breaker.bulk.err_percentage` | int | `50` | Checkout [CircuitBreaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) for more information |
+| `circuit_breaker.bulk.err_percentage` | int | `50` | See the [CircuitBreaker documentation](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) for more information |
-| `circuit_breaker.bulk.bucket_width` | Duration | `1s` | Checkout [CircuitBreaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) for more information |
+| `circuit_breaker.bulk.bucket_width` | Duration | `1s` | See the [CircuitBreaker documentation](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) for more information |
-| `circuit_breaker.bulk.buckets_count` | int | `10` | Checkout [CircuitBreaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) for more information |
+| `circuit_breaker.bulk.buckets_count` | int | `10` | See the [CircuitBreaker documentation](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) for more information |
-| `circuit_breaker.bulk.sleep_window` | Duration | `5s` | Checkout [CircuitBreaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) for more information |
+| `circuit_breaker.bulk.sleep_window` | Duration | `5s` | See the [CircuitBreaker documentation](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) for more information |
-| `circuit_breaker.bulk.volume_threshold` | int | `5` | Checkout [CircuitBreaker](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) for more information |
+| `circuit_breaker.bulk.volume_threshold` | int | `5` | See the [CircuitBreaker documentation](https://github.com/ozontech/seq-db/blob/main/network/circuitbreaker/README.md) for more information |

97-101: Typo: “Maxium” → “Maximum”.

-| `resources.cache_size` | Bytes | 30% of available RAM | Maxium size of cache. By default this setting is equal to 30% of available RAM |
+| `resources.cache_size` | Bytes | 30% of available RAM | Maximum cache size. By default this setting equals 30% of available RAM |

134-135: Tighten wording.

-| `mapping.update_period` | Duration | `30s` | Manages how often mapping file will be checked for updates |
+| `mapping.update_period` | Duration | `30s` | How often the mapping file will be checked for updates |
@@
-| `async_search.data_dir` | string | subdirectory in storage.data_dir | Directory that contains data for asynchronous searches. By default will be subdirectory in `storage.data_dir` |
+| `async_search.data_dir` | string | subdirectory in storage.data_dir | Directory that contains data for asynchronous searches. By default, this is a subdirectory in `storage.data_dir` |

Also applies to: 151-151

docs/en/01-quickstart.md (1)

88-92: Link LGTM; fix nearby flag mention.

The new cross-link is correct. Minor nit: below you mention “we set --mapping to auto”, but the setting is mapping.path: auto in config.

-Be aware that we set `--mapping` to `auto` for easier quickstart but this option is not production friendly.
+Be aware that we set `mapping.path: auto` for easier quickstart, but this option is not production-friendly.
docs/en/09-troubleshooting.md (1)

42-46: Align section title with new option name.

Update the heading to match storage.frac_size.

-### Reduce the frac-size
+### Reduce `storage.frac_size`

The updated body text and link look good.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a139084 and 6f95bc0.

📒 Files selected for processing (12)
  • docs/en/01-quickstart.md (1 hunks)
  • docs/en/02-configuration.md (1 hunks)
  • docs/en/02-flags.md (0 hunks)
  • docs/en/05-seq-ql.md (1 hunks)
  • docs/en/08-rate-limiting.md (1 hunks)
  • docs/en/09-troubleshooting.md (1 hunks)
  • docs/en/internal/frac-cache.md (1 hunks)
  • docs/ru/02-configuration.md (1 hunks)
  • docs/ru/02-flags.md (0 hunks)
  • docs/ru/08-rate-limiting.md (1 hunks)
  • docs/ru/09-troubleshooting.md (1 hunks)
  • docs/ru/internal/frac-cache.md (1 hunks)
💤 Files with no reviewable changes (2)
  • docs/ru/02-flags.md
  • docs/en/02-flags.md
✅ Files skipped from review due to trivial changes (4)
  • docs/ru/08-rate-limiting.md
  • docs/en/internal/frac-cache.md
  • docs/ru/internal/frac-cache.md
  • docs/ru/09-troubleshooting.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: test
🔇 Additional comments (2)
docs/ru/02-configuration.md (1)

1-176: Verify default initializations in config/config.go
The RG search only revealed validation rules, not where defaults are set. Inspect func NewConfig (or DefaultConfig) in config/config.go and confirm that values for api.es_version, limits.query_rate, storage.frac_size, etc., match the documented defaults.

docs/en/02-configuration.md (1)

1-176: Defaults match implementation. Documented defaults for api.es_version, limits.*, and storage.* align with the code.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
docs/ru/08-rate-limiting.md (1)

29-31: RU page is written in English; translate or move to EN.

This file lives under docs/ru but the new text (and the rest of the page) is English. Please either translate to Russian or relocate to docs/en to avoid locale confusion.

🧹 Nitpick comments (1)
docs/ru/08-rate-limiting.md (1)

29-31: Clarify defaults and show a config snippet.

State whether the rate limiter is disabled by default (i.e., unlimited) when limits.query_rate is unset, and add a minimal example snippet to avoid ambiguity.

 The rate limiter can be enabled on launch using the `limits.query_rate` option 
 followed by a number -- the maximum number of queries allowed per second. 
+
+Example (YAML):
+
+```yaml
+limits:
+  query_rate: 50  # 50 queries per second
+```
+
+Default: <please confirm> (e.g., disabled if not set).
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6f95bc0 and 4918d19.

📒 Files selected for processing (11)
  • docs/en/02-configuration.md (1 hunks)
  • docs/en/02-flags.md (0 hunks)
  • docs/en/05-seq-ql.md (1 hunks)
  • docs/en/08-rate-limiting.md (1 hunks)
  • docs/en/09-troubleshooting.md (1 hunks)
  • docs/en/internal/frac-cache.md (1 hunks)
  • docs/ru/02-configuration.md (1 hunks)
  • docs/ru/02-flags.md (0 hunks)
  • docs/ru/08-rate-limiting.md (1 hunks)
  • docs/ru/09-troubleshooting.md (1 hunks)
  • docs/ru/internal/frac-cache.md (1 hunks)
💤 Files with no reviewable changes (2)
  • docs/ru/02-flags.md
  • docs/en/02-flags.md
✅ Files skipped from review due to trivial changes (1)
  • docs/en/02-configuration.md
🚧 Files skipped from review as they are similar to previous changes (7)
  • docs/en/internal/frac-cache.md
  • docs/ru/internal/frac-cache.md
  • docs/en/05-seq-ql.md
  • docs/ru/02-configuration.md
  • docs/ru/09-troubleshooting.md
  • docs/en/09-troubleshooting.md
  • docs/en/08-rate-limiting.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: test

@ssnd ssnd merged commit df0eb6f into main Sep 10, 2025
9 checks passed
@ssnd ssnd deleted the 0-config-docs-v2 branch September 10, 2025 11:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants